بگذارید اهمیت تمیز نوشتن کدها یا Clean Code را با یک نقل قول از آقای مارتین فلور توضیح بدهم: «یک برنامه‌نویس افتضاح کسی‌ست که کدهایی را می‌نویسد که فقط کامپیوتر آن‌ها را درک می‌کند، یک برنامه‌نویس خوب اما، کسی است که کدهایی با قابلیت خوانده شدن توسط یک برنامه‌نویس دیگر را می‌نویسد.»
نقل قولی که در بالا مشاهده کردید یکی از کلیدی‌ترین موضوعاتی‌ست که مرز میان برنامه‌نویس خوب را از بد جدا می‌کند و در نهایت باعث می‌شود تا ما بتوانیم این نکته را درک کنیم که برنامه‌نویس خوب چه قابلیت‌هایی را دارد.
کد تمیز دقیقا همان هدفی را دارد که مارتین فلور در این نقل قول قصد داشته تا آن را به توسعه دهندگان بگوید.
در این مطلب از وبسایت آموزش برنامه نویسی راکت قصد داریم شما را با ۵ نکته کوتاه برای نوشتن کدهای تمیز آشنا کنیم.
نکته اول: از اسامی با معنی استفاده کنید
در تعریف متغیرها، توابع، کلاس‌ها و... سعی کنید از اسامی با معنی استفاده کنید. تعریف یک متغیر با نام a نمی‌تواند یک تعریف با معنی باشد چرا که چیزی به عنوان یک توضیح به ما ارائه نمی‌دهد.
در نتیجه سعی کنید حدالمکان از اسامی با معنی استفاده کنید. برای مثال اگر متغیری قرار است نام کاربری را در خود ذخیره کند حتما متغیری با نام username برای این موضوع تعریف کنید.
نکته دوم: تک وظیفه بودن را رعایت کنید
یکی از مهمترین قوانین برنامه‌نویسی این را می‌گوید که در زمان تعریف کلاس، ماژول یا توابع باید تک وظیفه بودن آن‌ها را رعایت کنید. منظور از تک وظیفه بودن این است که هر تابع یا کلاسی باید تنها یک کار را انجام دهد و محدوده کاری آن مشخص باشد. در غیر اینصورت ممکن است توابع یا کلاس‌ها و... کارهایی را انجام دهند که برای هم تیمی شما یک دفعه‌ای و غیر منتظره باشد.
نکته سوم: کدهای‌تان را DRY نگهدارید
منظور از عبارت DRY به معنای خشک نیست! بلکه منظور Don’t Repeat Yourself است. به این معنا که سعی کنید از انجام کارهای تکراری در کدهای‌تان خودداری کرده و سعی کنید که الگوی Reuse را پیش بگیرید.
هر کامپوننت یا قطعه کدی که ایجاد کرده‌اید را براساس الگوی Reuse پیاده‌سازی کنید و به این موضوع فکر کنید که برای هر داده جداگانه‌ای نیاز نیست که کامپوننتی را به صورت مستقل توسعه بدهید، بلکه از یک کامپوننت برای مکان‌های مختلف با داده‌های متفاوت استفاده کنید.
نکته چهارم: قواعد نامگذاری و استانداردهای زبان برنامه نویسی مورد نظرتان را بدانید
هر زبان برنامه‌نویسی یکسری قواعد و استانداردهای درونی دارد که با نام Conventions شناخته می‌شوند. در این استانداردها شیوه نامگذاری متغیرها، توابع و کلاس‌ها ایجاد شده و شما براساس یک استاندارد کلی برنامه‌تان را می‌نویسید.
در این حالت زمانی که هم تیمی شما که از همان زبان برنامه نویسی استفاده می‌کند، در روبرو شدن با اسامی و شکل‌های مختلف سرگردان نمی‌شود و می‌داند که دقیقا با چه چیزی روبرو خواهد بود.
نکته پنجم: کامنت تنها در موارد ضروری
زمانی که کدهای شما حاوی کامنت‌های بسیار زیادی باشد نشان از این می‌دهد که نتوانسته‌اید کدها را به صورت خود بیانگر یا تمیز بنویسید و برای هر قطعه کدی که نوشته‌اید نیاز به نوشتن توضیح پیدا کرده‌اید. در این حالت قبل از هر بار نوشتن یک کامنت سعی کنید الزامی بودن یا نبودن آن را متوجه شوید و سعی کنید کدها را به نوعی بنویسید که نیاز به کامنت نداشته باشند.
البته کامنت گذاری یکی از کارهایی‌ست که حتما باید انجام شود اما سعی کنید در بهینه‌ترین و بهترین حالت ممکن اینکار را انجام دهید.
در پایان
تمیزنویسی کدها یکی از ویژگی‌های بسیار مهم برنامه‌نویس‌های حرفه‌ای است. حتما سعی کنید موارد گفته شده را رعایت کرده و به بهترین شکل ممکن کدهای‌تان را تمیز و Clean بنویسید. پیشنهاد شما برای تمیزتر نوشتن کدها چیه؟
دیدگاه و پرسش
در حال دریافت نظرات از سرور، لطفا منتظر بمانید
در حال دریافت نظرات از سرور، لطفا منتظر بمانید