کد تمیز (Clean Code) به کدی گفته می‌شود که خواندن، فهمیدن و نگهداری آن برای برنامه‌نویسان آسان باشد. این نوع کد نه فقط برای نویسنده اصلی بلکه برای هر کسی که بعداً با آن سروکار دارد، قابل درک است. اما منظور از «تمیز بودن» کد چیست؟ در ادامه ویژگی‌های کد تمیز و برعکس آن توضیح داده شده است:
ویژگی‌های کد تمیز:
- نامگذاری معنادار و واضح: متغیرها، توابع و کلاس‌ها باید طوری نامگذاری شوند که هدف و نقششان به‌راحتی قابل فهم باشد. مثلاً به جای نام‌های مبهم مثل
xیاtmpاز نام‌هایی مانندuser_ageیاcalculate_totalاستفاده شود. - ساختار منظم و قالب‌بندی استاندارد: تورفتگی (indentation) و فاصله‌گذاری مناسب باعث خوانایی بیشتر کد می‌شود. خطوط کد نباید خیلی بلند باشند و بهتر است کد به بخش‌های کوچک‌تر تقسیم شود.
- تابع‌ها و کلاس‌های کوچک و تک وظیفه‌ای: هر تابع یا کلاس باید یک وظیفه مشخص و محدود داشته باشد (اصل تک مسئولیتی). این موضوع باعث می‌شود کد قابل تست و فهم‌تر شود.
- کاهش کد تکراری: با استفاده از توابع و متدهای مناسب باید از نوشتن کدهای مشابه در چند جای مختلف جلوگیری کرد (اصل DRY: Don’t Repeat Yourself).
- کامنت‌گذاری مناسب و به‌جا: توضیحات باید فقط در جایی قرار گیرند که کد نیاز به توضیح بیشتر دارد، نه کامنت‌های اضافه یا توضیح آنچه کاملاً واضح است.
- مدیریت صحیح خطاها: استفاده درست از ساختارهای خطا (try-except) به‌گونه‌ای که برنامه به شکل قابل پیش‌بینی و امن اجرا شود.
- رعایت استانداردهای زبان برنامه‌نویسی: مثلاً در پایتون رعایت PEP 8 که شامل قوانین نامگذاری، قالب‌بندی، فاصله‌ها و … است.
نمونه‌های کد تمیز: نامگذاری مناسب، توابع کوتاه با یک وظیفه، استفاده از فضاهای خالی برای جداکردن بخش‌ها، عدم تکرار کد، مستندسازی با docstring و غیره.
ویژگی‌های کد نامنظم یا غیرتمیز:
- نام‌های نامفهوم و مبهم: استفاده از نام‌هایی مانند
a،dataیاfooبدون هیچ معنی مشخص. - کدهای طولانی و پیچیده: توابع و کلاس‌های بزرگ که چندین وظیفه دارند و فهمیدن منطق آن‌ها سخت است.
- کد تکراری زیاد: نوشتن چندباره کد مشابه در نقاط مختلف برنامه.
- نداشتن قالب‌بندی مناسب: تورفتگی‌های نامناسب، نبود فاصله‌گذاری‌ها، خطوط بسیار بلند و بهم ریختگی در کد.
- کامنت‌های بی‌معنی یا کمبود کامنت: یا کامنت‌هایی که فقط تکرارکننده کد هستند یا کدی که اصلاً توضیحی ندارد.
- عدم رعایت استانداردهای زبان: مثلاً در پایتون ننوشتن کد مطابق با PEP 8 باعث کاهش خوانایی می‌شود.
در مجموع، کد تمیز باعث می‌شود توسعه‌دهندگان بتوانند سریع‌تر کد را بفهمند، اشکالات را بهتر پیدا کنند و تغییرات را آسان‌تر اعمال نمایند. برعکس، کد نامنظم منجر به سردرگمی، افزایش خطا و سختی در نگهداری پروژه می‌شود. پس همیشه توصیه می‌شود از ابتدا کد خود را مرتب، واضح و استاندارد بنویسید.