چگونه کد تمیز بنویسیم؟

کد تمیز (Clean Code) چیست؟

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

احتمالا برای شما هم پیش اومده که با کدهایی روبرو شدین که از کار کردن با اونها حس خوشایندی نداشتین و به نوعی احساس آشفتگی داشتین. این کدها می‌تونه کد افراد دیگه یا کدهای خودتون بعد از مدت زمان نسبتا طولانی باشه. دلیل عمده اینه که در اون کدها اصول کدنویسی تمیز رعایت نشده.

توی این پست قصد دارم تا چند نکته برای نوشتن کدهای خوانا بگم.

استفاده از نام‌های با معنا

به عنوان یک اصل پایه همواره سعی کنید که از نام‌های مناسبی برای متغیرها،‌ متدها،‌ کلاس‌ها و سایر بخش‌های برنامه‌تون استفاده کنید. حتی الامکان اسامی‌تون واضح و به دور از هرگونه ابهام و پیچیدگی باشه.

اصل DRY

یه اصل رایج تو مهندسی نرم‌افزار وجود داره به نام DRY یا Don't Repeat Yourself که به معنای خودت رو تکرار نکن هستش. احتمالا شما هم تکه کدهایی مختلفی از برنامه‌تون رو دیدین که در جاهای مختلفی دقیقا تکرار شده‌اند. به نوعی برنامه‌نویس مورد نظر به دلیل تنبلی و یا عجله در تحویل پروژه یه سری جاها رو صرفا کپی پیس کرده. راهکار اینه که اون بخش‌ها رو داخل توابع جداگانه‌ای تعریف کنید و در بخش‌های مورد نیاز فقط نام تابع رو فراخوانی کنید، اینجوری دیگه مجبور نیستید که بدنه‌ی تابع رو در بخش‌های مختلف کپی پیس کنید و اگه در آینده نیاز به تغییر بود فقط کافیه که یه بار دستورات داخل تابع رو ویرایش کنید بدون اینکه سایر بخش‌ها نیاز به تغییر داشته باشه

استفاده از کامنت‌های معنادار

کامنت به معنای توضیح هستش و کامنت‌ها در زبان‌های برنامه‌نویسی بخش‌هایی هستند که توسط کامپایلرها و مفسرها نادیده گرفته میشن و به عنوان نوعی توضیح و راهنما برای سایر برنامه‌نویسان استفاده میشه.

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

پرهیز از توابع بلند

همه‌ی ما می‌دونیم که کار کردن با توابع طولانی آسون نیستش، هم خوندن اونها و هم اعمال تغییرات در اونها. ترجیحا تو اونجایی که میشه توابع‌تون رو به بخش‌های مختلفی بشکنید و اونها رو در زیر توابع جداگانه‌ای تعریف کنید. اینجوری هم حجم توابع‌تون از لحاظ تعداد خطوط کم‌تر میشه و هم کار کردن با اونها آسون‌تر میشه.

بیشتر بخوانید

اگه به مبحث کدنویسی تمیز علاقه‌مند هستید می‌تونید از طریق لینک زیر به مجموعه مقالات آموزشی کدنویسی تمیز دسترسی داشته باشین. توی این سلسله مقالات، نکاتی درباره نوشتن کدهای خوانا رو توضیح دادیم.

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