clean code چیست؟
کدنویسی تمیز (Clean Code) مجموعه اصولی است که به شما کمک میکند کدی بنویسید، که فهم و اصلاح آن توسط دیگران و یا بعد از مدتهای طولانی برای خودتان سخت نباشد. این اصول استانداردهایی هستند که اگر رعایت شوند، شما را تبدیل به یک برنامه نویس حرفه ای میکنند. کدنویسی تمیز در کار گروهی اهمیت بسیار زیادی دارد.
در متدولوژی هایی مانند چابک (Agile) کدنویسی تمیز ضروری به نظر میرسد زیرا اعضای تیم، در بسیاری از موارد ناچار به تکمیل و اصلاح کدهای یکدیگر هستند. کد کثیف (Dirty Code) اصطلاحی است که در برابر کدنویسی تمیز وجود دارد. عدم رعایت اصول کدنویسی تمیز، بی نظمی و استفاده از رویههای تکراری کد شما را به Dirty Code تبدیل میکند.
اهمیت استفاده از اصول clean code چیست؟
کدنویسی تمیز اهمیت زیادی در هزینه زمانی و نیروی انسانی تیمهای فنی دارد. طبق تحقیقاتی که انجام شده معمولا توسعه دهندگان ۳۰ تا ۴۰ درصد زمان خود را صرف نوشتن کدهای جدید میکنند. این در حالی است که حدود ۶۰ درصد از زمان آنها صرف نگهداری و اصلاح (Debug) کدها میشود.
اصول کدنویسی تمیز چیست؟
- سادگی کدها (KISS) : Keep It Simple Stupid یکی از اولین اصول در کدنویسی تمیز و به این معنی است که از پیچیدگی بیش از حد کدها بپرهیزیم و در سادهترین شکل ممکن برنامه نویسی کنیم. بنابراین سعی کنید توابع را در سادهترین شکل ممکن بنویسید و تاحد ممکن از اضافه کردن پیچیدگیهای بی مورد دوری کنید.
- خوانایی و قابل فهم بودن کدها : هرچه میزان خوانایی و فهم کدها راحتتر باشد، زمان کمتری برای اصلاح آنها لازم است.
- نام گذاری مناسب : برای کلاسها و توابع مختلف، نام گذاری مناسب انجام دهید. این کار به ترتیب روند کار و راحتی در جستجوی بخشهای مختلف کمک زیادی خواهد کرد. نام یک کلاس یا تابع باید متناسب با عملکرد آن باشد
- مدیریت آرگومان ها: بهتر است توابع آرگومانهای زیادی نداشته باشند. همچنین بدنه هر تابع را تا جایی که ممکن است به قسممتهای مختلف شکسته و در توابع مختلف قرار دهید.
· عدم کامنت گذاری : اگر در کد خود کامنتهای زیادی میگذارید احتمالا اشتباهی در کار است. کد شما باید به قدری واضح باشد که نیازی به توضیحات اضافه نداشته باشد.