چک لیست یک برنامه نویس Clean Code

نوشتن کد تمیز
نوشتن کد تمیز


کد تمیز یا Clean Code یعنی کدی که قابل توسعه و خوانا باشد . تبدیل شدن به یک برنامه نویس کد تمیز ، شامل رعایت موارد زیر است.

1- جهت ماژول بندی بهتر طول توابع نباید بیش از 25 تا 30 خط شود.

2- سعی کنید گویا ترین نام را برای اجزای برنامه تان انتخاب کنید.

3- از مدیریت ورودی توابع (نهایتا 4 مورد), جهت پوشش تک مسولیتی بهره بگیرید.

4- از نوشتن کلاس های بزرگ در برنامه تان خودداری کنید.

5- در استفاده از کتابخانه ها یا برنامه های Third-Party نهایت دقت را به کار ببرید.

6- دیزاین پترن ها را بشناسید و از آن ها استفاده کنید.

7- همیشه نفر بعدی که از کد شما استفاده می‌کند را مد نظر بگیرید.

8- یاد بگیرید کد های دیگران را بخوانید.

9- ساده ترین و کامل ترین راه را برای حل مشکل استفاده کنید.

10- سعی کنید، آنقدر خوب کد بنویسید که به کامنت نیازی نداشته باشید.

11- رعایت قوانین SOLID مهم تر از استفاده از design pattern ها می باشد.

12- از تکرار کدهای مشابه یا اصطلاحا" Duplicate Code بپرهیزید.

13- بخش های مرتبط را encapsulate کنید.

14- قانون تک مسولیتی بودن را سرلوحه کد نویسی کنید.

15- قانون Open/Closed را برای راحتی آینده خود رعایت کنید.

16- با رعایت Dependency Inversion توسعه پذیری برنامه تان را متحول کنید.

17- از تعداد زیادی if , برای پوشش چند مسولیتی بودن پرهیز کنید.

18- در تمام کد از یک سری از قوانین و الگو ها استفاده کنید.

19- روزانه یا هفتگی کد خود را ریفکتور کنید.

20- قبل کد زدن آنرا دوبار مرور کنید (روی برگه طراحی و Review کنید) .

21- برای کد خود تست بنویسید.