کد تمیز چیست و چه طور می‌توان Clean Code نوشت ؟
کد تمیز یا (Clean Code) به شکلی از کدنویسی گفته می‌شود که فهم و توسعه‌ی آن آسان باشد و الگوهای خوب برنامه‌نویسی، اصول و رویه‌های منطقی و قواعد ساده و قابل فهم برنامه‌نویسی را دنبال کند.
مزایای نوشتن کد تمیز یا Clean Code
از مزایای نوشتن کد تمیز می‌توان به موارد زیر اشاره کرد:
- یکپارچگی و قابلیت تغییر
کد تمیز از پیچیدگی‌های اضافی و بی‌اهمیت خودداری می‌کند و پیاده‌سازی‌های ساده و مرتب را اصل اولیه قرار می‌دهد. این موضوع باعث می‌شود که کد قابلیت توسعه و اصلاح را داشته باشد و مشکلات کمتری در جریان ویرایش و توسعه‌ی آن به وجود بیاید. - افزایش قابلیت خوانایی و قابلیت درک توسط دیگران
کد تمیز بهترین مستندات و راهنما برای کدهای برنامه‌نویسی است. وقتی کدی تمیز نوشته می‌شود، دیگر برنامه‌نویسان به راحتی می‌توانند منطق و عملکرد آن را فهمیده و مفهوم کلی برنامه‌نویسی را بفهمند. - کاهش تکرار
استفاده از کدهای منظم و تمیز باعث می‌شود که ماژول‌ها و شیوه‌های برنامه‌نویسی در یک نقطه تغییر دهیم، بدون آنکه نگرانی از دست دادن پارامترهای دیگر باشیم. - کاهش خط ایجاد باگ یا خطا
نوشتن کد تمیز معمولا به معنی کاهش خطا، به شکلی که کمترین مقدار کدهای ناسازگار یا دارای خطا پنهان باقی بمانند است. بسیاری از خطاهایی که هنگام برنامه‌نویسی رخ می‌دهد با نوشتن کد تمیز به آسانی شناسایی می‌شوند و پیش از ایجاد مشکل از بین می‌روند. - تجربه‌ی کاربری بهتر
یک کد تمیز معمولا بدون باگ و دارای اشکال کمتری است در نتیجه کاربران تجربه‌ی بهتری از استفاده‌ی نرم‌افزار پیدا می‌کنند.
چه طور کد تمیز بنویسیم ؟
نوشتن کد تمیز یک عادت است که باید برای آن قانون و الزام وجود داشته باشد. در تیم‌های بزرگ گاهی کدهایی که با رعایت قوانین نوشته نشده باشند، پذیرش نمی‌شوند و تنها پس از پاکسازی و رعایت اصول می‌توان کدهای جدید را به مخزن کدهای قبلی اضافه نمایید.
در هنگامی که برنامه‌نویس به تنهایی کار می‌کند، عادت‌های شخصی و آگاهی از مزایایی که نوشتن کد تمیز برای خودش و برای استفاده کنندگان از نرم‌افزار به دنبال دارد، مشوقی عالی در جهت نوشتن کدهایی تمیز است.
مهم‌ترین اصول برای نوشتن کد تمیز
- Nomenclature and Naming Conventions
نام‌گذاری منطقی و معنادار متغیرها، توابع و کلاس‌ها یکی از نکات اساسی در نوشتن کد تمیز است. از نام‌گذاری صحیح و قابل فهم برای دیگران استفاده کنید به‌طوری که برنامه نویسان و همکاران شما بتوانند به راحتی منظور و عملکرد هر قسمت را درک کنند. - Code Structure
ساختار منطقی کد اهمیت زیادی دارد. باید از تورفتگی مناسب، فضاهای خالی (Whitespace) و گروه‌بندی کد برای یافتن مشخصه‌ها و ایجاد یک گردش کار منطقی و قابل فهم استفاده کنید. - Commenting and Documentation
استفاده از توضیحات و کامنت‌های مناسب برای قطعات کلیدی کد ضروری است. همیشه قسمت‌هایی از کد وجود دارد که به توضیحات بیشتر نیاز دارد تا در زمان تغییر یا توسعه،فهم آن آسان‌تر باشد. - Single Responsibility Principle (SRP)
از اصل پاسخگویی تکی (SRP) بهره ببرید. هر قطعه کد باید یک مسئولیت انجام یک کار مشخص را داشته باشد و اگر قطعه‌ای از کد چند کار را انجام می‌دهد، بهتر است آن را به قطعات کوچک‌تر که وظایفی مشخص‌تر و ساده‌تر بر عهده دارند، تقسیم نمایید. - Avoidance of Code Duplication
تکرار کد یکی از مشکلات اساسی در نوشتن کد تمیز است. اگر با یک قطعه کد مواجه شدید که بتوانید آن را دوباره استفاده کنید، بهتر است کدهای خود را طوری تغییر دهید تا قسمت‌های تکراری تنها یک‌بار نوشته شوند و بخش‌هایی که به این عملکرد نیاز دارند همگی آن را فراخوانی کنند. - Unit Testing
نوشتن تست‌های واحد (Unit Tests) به شما کمک می‌کند تا مطمئن شوید، کدی که می‌نویسید، به درستی کار می‌کند. این کار همچنین موجب افزایش اعتماد دیگر برنامه‌نویسان به کدهای شما می‌شود.