اصول کد تمیز برای پروژه‌های واقعی

کد فقط یک‌بار نوشته می‌شود اما بارها خوانده می‌شود — توسط هم‌تیمی‌ها، و توسط خودِ آینده شما. کد تمیز یعنی کدی که شش ماه بعد هم به‌راحتی قابل فهم و تغییر باشد. این مقاله اصول عملی کد تمیز را با تمرکز بر پروژه‌های واقعی بررسی می‌کند.

چرا کد تمیز اهمیت دارد؟

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

هر احمقی می‌تواند کدی بنویسد که کامپیوتر بفهمد؛ برنامه‌نویسان خوب کدی می‌نویسند که انسان‌ها بفهمند.

اصول کلیدی

نام‌گذاری شفاف

نام متغیرها و توابع باید نیت آن‌ها را آشکار کند. $userCount بسیار بهتر از $uc است. نام خوب، نیاز به کامنت توضیحی را از بین می‌برد.

توابع کوچک و تک‌مسئولیتی

هر تابع باید فقط یک کار انجام دهد و آن را خوب انجام دهد. اگر برای توصیف یک تابع مجبورید از کلمه «و» استفاده کنید، احتمالاً آن تابع بیش از یک مسئولیت دارد و باید شکسته شود.

پرهیز از تکرار

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

کامنت‌ها: کمتر اما بهتر

بهترین کامنت، کدی است که نیازی به کامنت ندارد. کامنت باید «چرا» را توضیح دهد، نه «چه». اگر کد شما نیاز به توضیح «چه کاری می‌کند» دارد، احتمالاً باید خود کد را خواناتر کنید.

• کامنت‌های منسوخ، بدتر از نبود کامنت هستند.
• به‌جای توضیح کد بد، کد را بهتر بنویسید.
• تصمیم‌های غیرواضح را با «چرا» مستند کنید.

جمع‌بندی

کد تمیز یک مهارت اکتسابی است که با تمرین آگاهانه رشد می‌کند. با نام‌گذاری شفاف، توابع کوچک، پرهیز از تکرار و کامنت‌های هدفمند، می‌توانید کدی بنویسید که نگهداری آن لذت‌بخش باشد. هر بار که کدی می‌نویسید، از خودتان بپرسید: «آیا فردِ بعدی این را به‌راحتی می‌فهمد؟»