چگونه کدهای خود را زیبا و خوانا نگه داریم؟

10 توصیه واقعی، و اجرایی برای نوشتن کدی که هم ماشین بفهمد، هم برنامه نویس لذت ببرد

کد خوب فقط کدی نیست که اجرا شود!

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

کدی که قابل فهم نباشد، حتی اگر بدرستی اجرا شود، مثل آشپزی است که غذا را بدون نمک و بدون سلیقه می‌پزد: شکم را سیر می‌کند، اما دل را نه.

در این مقاله، قرار نیست فقط بصورت تئوری موارد رو بیان کنیم تئوری کنیم. اینجا ۱۰ راهکار واقعی و ملموس را می‌خوانید که می‌توانید از همین امروز در کدنویسی‌تان اجرا کنید. آماده‌اید؟ برویم سراغ اصل ماجرا.

 ۱. از نام‌هایی استفاده کنید که خودشان حرف بزنند

نام متغیر، تابع، کلاس و فایل باید آن‌قدر واضح باشد که نیاز به توضیح نداشته باشد.

❌ اشتباه:

var d = GetData();

✅ درست:

var activeUserList = FetchActiveUsers();

🟢 راهنمای سریع:

توابع → با فعل شروع شوند: calculateTax, sendEmail

متغیرها → با اسم دقیق داده یا نقششان: userAge, orderTotal

۲. توابع را کوتاه، تک‌وظیفه‌ای و تمیز بنویسید

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

❌ اشتباه:

void HandleRequest() {
    Validate();
    SaveToDatabase();
    SendNotification();
}

✅ درست:

void HandleRequest() {
    if (!Validate()) return;
    Save();
    NotifyUser();
}

📌 اگر نتوانستید اسم تابع را در سه کلمه معنی‌دار خلاصه کنید، احتمالاً زیادی بزرگ شده!

 ۳. از تکرار کد فرار کن (اصل DRY)

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

✅ راهکار:

کدهای تکراری را در توابع جدا بنویسید

حتی یک قطعه دو خطی هم اگر تکرار شد، توجیه دارد

مثال:

void PrintError(string message) {
    Console.ForegroundColor = ConsoleColor.Red;
    Console.WriteLine(message);
    Console.ResetColor();
}

۴. از فاصله‌گذاری درست و قالب‌بندی منظم استفاده کنید

کدهای به‌هم چسبیده چشم را خسته می‌کنند. کدی که مرتب باشد، فهمیدن منطقش هم راحت‌تر است.

❌ اشتباه:

function login(u,p){if(u&&p){auth(u,p)}}

✅ درست:

function login(username, password) {
    if (username && password) {
        authenticate(username, password);
    }
}

🛠 ابزار کمک‌کننده:

Prettier برای جاوااسکریپت

Black برای پایتون

Roslyn یا StyleCop برای سی‌شارپ
🎯 پیشنهاد ویژه: فعال‌سازی Format on Save در ادیتور

 ۵. کدی بنویسید که خودش را توضیح دهد

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

📌 کامنت خوب: دلیل را توضیح می‌دهد
❌ بد:

// افزایش مقدار
count++;

✅ خوب:

// جبران اختلاف یک واحدی در انتهای حلقه
count++;

✅ ۶. ساختار پوشه‌ای و فایل‌ها را تمیز نگه دارید

اگر پروژه شما از دو فایل فراتر رفته، وقت آن است که ساختار پوشه‌ای منظمی داشته باشید.

📁 پیشنهاد ساختار:

📁 User
   ├── UserService.cs
   ├── UserController.cs
   └── UserValidator.cs

📁 Product
   ├── ProductService.cs
   └── ProductViewModel.cs

📌 دسته‌بندی به‌صورت «بر اساس دامنه» (Domain-based) یا «بر اساس فیچر» (Feature-based) خیلی به خوانایی و مقیاس‌پذیری کمک می‌کند.

 ۷. قبل از ارسال کد، حتماً آن را مرور کنید

یک عادت حرفه‌ای: قبل از اینکه commit بزنی یا push کنی، کدتان را مرور کنید.

👀 از خودت بپرس:

آیا اگر این کد را کسی دیگر نوشته بود، راحت آنرا می فهمد؟

آیا می‌توان بخشی از آن را ساده‌تر، کوتاه‌تر یا واضح‌تر نوشت؟

💬 قانون طلایی: هرچه زودتر کدتان را بخوانید، اشکالات کمتری به آینده منتقل می‌کنید.

۸. از ابزارهای بررسی کیفیت کد (Lint و Analyzer) استفاده کنید

این ابزارها به‌صورت خودکار مواردی مثل نام‌گذاری غلط، تکرار کد، بی‌نظمی در importها و حتی کدهای خطرناک را هشدار می‌دهند.

🛠 ابزارها:

ESLint برای JavaScript

Pylint یا Flake8 برای Python

SonarLint یا ReSharper برای #C

📌 این ابزارها در تیم‌ها ضروری‌اند، اما برای پروژه‌های شخصی هم کیفیت را چند پله بالا می‌برند.

 ۹. برای بخش‌های مهم تست بنویسید

کدی که تست ندارد، یعنی هیچ تضمینی برای عملکرد درست آن نیست. برای توابع کلیدی، تست‌های ساده بنویسید.

🧪 مثال:

اگر تابعی تاریخ را فرمت می‌کند → آن را تست کن که آیا خروجی درست است

اگر چیزی را ذخیره می‌کند → بررسی کنی که مقدار دقیق ذخیره شده باشد

🛠 ابزارها:

xUnit برای NET.

Jest برای JS

PyTest برای Python

 ۱۰. فرض کنید شش ماه بعدخودتان قرار است این کد را بخوانید  

آخرین و شاید مهم‌ترین توصیه:
کدی بنویسید که خودتان ۶ ماه بعد، با خستگی، عجله یا استرس هم بتوانید آنرا بفهمید.

📌 ساده بنویس، قابل‌فهم بنویس، انسانی بنویس.
کد خوب فقط برای CPU نوشته نمی‌شود، برای آدم‌ها هم هست.

 جمع‌بندی: چک‌لیست طلایی برای کدنویسی خوانا و حرفه‌ای