چطور تمیز کد بزنیم

نوشتن کد‌های پروژه یک موضوعه اما نوشتن کدهایی تمیز و خوانا یک چیز دیگه.
اما کدی تمیز به چه کدی گفته می‌شه؟
کدها باید زیبا و لطیف باشن، به سادگی خونده بشن و با خوندنشون لبخند رو لب‌تون بیاد؛ از همه مهم‌تر بعد از خوندن کدها باید متوجه بشین دقیقا چه کاری داره انجام می‌شه.

این پست رو دنبال کنید تا چند نکته ساده رو باهم بررسی کنیم.

درست نام‌گذاری کنید‍!
مهم نیست از چه اسم‌هایی در پروژه استفاده می‌کنید؛ فقط دقت کنید که نام‌گذاری شما به سه سوال مهم جواب بده:
- این کد چه کاری انجام می‌ده؟
- این کد به چه علت وجود داره؟
- این کد چطور استفاده می‌شه؟

تابع‌هایی با عملکرد بهتر بنویسید/ از فرمت‌بندی‌های سازگار استفاده کنید!

- کوتاه ولی گویا بنویسید.
- دقت کنید، تابعی که می‌نویسید تنها یک وظیفه رو انجام بده.
- از یک استایل خاص برای نام‌گذاری در کل برنامه‌تون استفاده کنید.

- از ساختارهای پیچیده استفاده نکنید.

کامنت‌گذاری کنید!

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

کدهایی بنویسید که برای دیگران خوانا باشه!

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