کثیف کد نزنیم

چند وقتی هست که یک پروژه بسیار بزرگ (از لحاظ حجم کد) به‌ دستم رسیده و من باید اون رو تکمیل کنم، در مرحله اول خب باید کد‌های نفر قبلی رو بخونم.
دقیقا مشکل منم از همین جا شروع میشه، خوندن کد‌های نفر قبلی :(
شاید در نگاه اول کار زیاد سختی نیاد، ولی وقتی شروع به خوندن کد‌های کثیف (به قول بعضی از دوستان 'کثافت') و بدون کامنت یک نفر می‌کنید، این قضیه بسیار خسته کننده میشه، تا جایی که حاضرید کل پروژه رو خودتون از اول بزنید ولی دیگه کد نخونید.

سوال اصلی اینجاست، ما باید چی کار کنیم که نفر بعدی از خواندن کد‌های ما، خسته نشه :)

• مهم ترین چیز به نظر من (یا شاید خیلی‌ها) کامنت هست، که متاسفانه تو این پروژه به جای کامنت‌های با معنا در مورد عملکرد تکه‌های پروژه، یکسری کد بی‌مصرف کامنت شدن، که این مسئله خیلی خیلی آزار دهنده ست.

• نکته بعدی اینکه سعی کنید دوباره چرخ رو اختراع نکنید.
  وقتی این همه کتابخونه و ماژول‌های متن‌باز و خوب هست، چرا ما باید بشینیم خودمون دوباره اون‌ها رو باز نویسی کنیم؟
  این کار باعث این میشه که ما پروژه رو بیشتر کثیف کنیم.

• تا جایی که معقوله برنامه‌مون رو به فانکشن‌های کوچک تقسیم کنیم.
  این کار نه تنها باعث میشه خودمون موقع کد زدن راحت باشیم، بلکه نفر بعدی هم بخواد کد‌های ما رو تغییر بده پدرش در نمیاد.

• و در آخر هم سعی کنیم از Style Guide ها استفاده کنیم.
  هر زبان برنامه‌نویسی یکسری قوانین نوشتاری مخصوص به خودش رو داره، مثلا پایتون یکسری قوانین معروف داره که بهش می‌گن PEP.
  انجام این کار هم مثل نکته‌های قبلی زیاد سخت نیست، اگر از IDE استفاده می‌کنید، احتمالا خودش راهنمایی‌تون می‌کنه. اگر هم از Editor استفاده می‌کنید، با نصب پلاگین‌های مخصوص احتمالا تا حد بسیار زیادی راهنمایی میشید.
  ولی از همه مهم‌تر این هست که خودتون این قوانین رو یاد بگیرید و بدون پلاگین بتونید پیاده‌سازی کنید (همونجوری که اول گفتم زیاد سخت نیست).

شما با انجام این کار‌های ساده، تا حدودی باعث می‌شوید نفر بعدی که کد‌های شما رو می‌خونه از شما و خاندان شما متنفر نشه :)