منبع اصلی نوشتار زیر در این لینک قرار دارد

استاندارد نویسی کد در PyQt

درود خدمت دوستان در این پست می خوام نکاتی را درباره استاندارد نویسی کد یادآوری بکنم اول باید اهمیت استاندارد را در کدها درک کنیم تا بتوانیم یک پروژه موفق رو کلید بزنیم در واقع رعایت نکردن استانداردها در کوتاه مدت و بلند مدت باعث مرگ و شکست یک پروژه می شود. در کوتاه مدت اثرش این هست که برنامه نویسان و گسترش دهندگان دیگر پروژه با عدم درک و فهم کد مواجه خواهند شد که باعث دل زدگی ، خستگی ، و اتلاف وقت شریکان و گسترش دهندگان برنامه یتان می شوید و اثر دراز مدتش هم به خود شخص شما بر می گرده که فرضا پروژه ای رو یک سال قبل انجام دادین اکنون برای استفاده مجدد و گسترش و بهینه سازی برنامتون به اون مراجعه می کنین ولی این بار با مشکل عدم فهم و درک کدی مواجه هستین که یکسال قبل شما خودتون همه کارشو رو انجام دادین . در زیر به چند قانون برای بهتر کردن کدهامون یادآوری می کنم که رعایت اونها الزامی است:

۱- برای انتخاب نام یک ایتم یا متغیر اگر نام انتخابی از چند واژه تشکیل شده باشد نخستین حرف هر واژه را با حروف بزرگ می نویسیم به هیچ صورت از فعل ها برای نامگذاری ایتم ها استفاده نکنین. فعل ها مانند: add,save,update,delete,…

2- درنامگذاری ایتم ها در پایکیوت  نوع آیتم را هم ذکر کنین تا مشخص شود که شی مربوط به چه ویدجتی می باشد. برای مثال :

NameLabel = QLabel('name')
NameEdit = QLineEdit()

3- برای نام گذاری توابع و متدها سعی کنین بجای استفاده از اسم از فعل استفاده کنین یعنی فعلی که تابع انجام می دهد مثلا فعل های save , delete, add, submit ,..  برای نام گذاری متدها سودمند هستن

۴- در هرجا از کد که لازم باشه از کامنت ها یا توضیحات برای یادداشت نکات و توضیحات کد استفاده کنین. این کار به خوانایی کد برای گسترش دهندگان دیگر و همچین برای خود شما که پس از مدت ها به سورس رجوع می کنین بسیار یاری رسان هستش.

۵- حتما  توو رفتگی ها و فاصله ی خطوط ، ظاهر شکیل کد رو حفظ کنین تا باعث خستگی و سردرگمی دیگران نشوید.

در پایان نکات بالا نه تنها برای فریمورک پایکیوت  بلکه برای هر برنامه ای با هر زبانی یک قانون نانوشته هستن که رعایت انها الزامی می باشد :)

 

 

 



برچسب ها :

به سیاره لینوکس امتیاز دهید

به اين صفحه امتياز دهيد