اصول کدنویسی تمیز

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

Clean Code یا کد تمیز چیست؟

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

چرا Clean Code مهم است؟

1. خوانایی: خواندن کد تمیز آسان است، به این معنی که هر کسی - از جمله خود شما در آینده - می تواند آن را به سرعت درک کند. این امر زمان لازم برای درک عملکرد کد را کاهش می دهد و منجر به توسعه سریعتر و اشکال زدایی راحت تر می شود.
2. قابلیت نگهداری: کد بیشتر از آنچه نوشته شده خوانده می شود. هنگامی که کد تمیز می نویسید، به مرور زمان نگهداری و گسترش برنامه آسان تر می شود. این در چرخه عمر توسعه نرم افزار، جایی که پروژه ها اغلب تکامل می یابند و رشد می کنند، بسیار مهم است.
3. همکاری: کد تمیز همکاری را تشویق می کند. وقتی کد شما تمیز و منظم باشد، سایر اعضای تیم می توانند به طور موثر روی آن کار کنند. این کار تقسیم وظایف و کار بر روی بخش های مختلف پایگاه کد را به طور همزمان آسان تر می کند.
4. کاهش باگ: کد تمیز احتمال معرفی باگ ها را کاهش می دهد. کدهایی که درک آن دشوار است، بیشتر در معرض خطا در هنگام اصلاحات یا بهبود هستند.
5. کارایی: کد تمیز کد کارآمد است. معمولاً سریعتر اجرا می شود و از منابع کمتری استفاده می کند زیرا از عملیات غیر ضروری و پیچیدگی جلوگیری می کند.

اکنون که متوجه شدیم چرا کد تمیز مهم است، اجازه دهید برخی از بهترین شیوه ها و اصول را بررسی کنیم تا به شما در نوشتن کد پاک کمک کنند.

بهترین روش ها و اصول برای نوشتن کد تمیز

1- نام های معنی دار متغیرها و توابع

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

# Bad variable name
x = 5

# Good variable name
total_score = 5

2- توابع و روش ها را کوتاه نگه دارید

توابع و روش ها باید مختصر و متمرکز بر یک کار واحد باشند. اصل مسئولیت واحد (SRP) بیان می کند که یک تابع باید یک کار را انجام دهد و آن را به خوبی انجام دهد. درک، آزمایش و نگهداری توابع کوتاه‌تر آسان‌تر است. اگر یک تابع خیلی طولانی یا پیچیده شد، آن را به توابع کوچکتر و قابل مدیریت تقسیم کنید.

// Long and complex function
function processUserData(user) {
    // Many lines of code...
}

// Refactored into smaller functions
function validateUserInput(userInput) {
    // Validation logic...
}

function saveUserToDatabase(user) {
    // Database operation...
}

3- توضیحات و مستندات

از توضیحات به اندازه کافی استفاده کنید و زمانی که این کار را کردید، آنها را معنادار کنید. کد باید تا حد امکان خود توضیحی باشد. اسناد، مانند توضیحات درون خطی و فایل‌های README، به توسعه‌دهندگان دیگر کمک می‌کنند تا هدف و کاربرد کد شما را درک کنند. الگوریتم های پیچیده، تصمیمات پیچیده و API های عمومی را مستند کنید.

# Bad comment
x = x + 1  # Increment x

# Good comment
# Calculate the total score by incrementing x
total_score = x + 1

4- قالب بندی و تورفتگی سازگار

به سبک کدنویسی و تورفتگی ثابت پایبند باشید. این امر باعث می شود که پایگاه کد تمیز و منظم به نظر برسد. اکثر زبان های برنامه نویسی دارای استانداردهای کدنویسی پذیرفته شده توسط جامعه خود هستند (به عنوان مثال، PEP 8 برای پایتون، eslint برای جاوا اسکریپت) که باید از آنها پیروی کنید. سازگاری همچنین قراردادهای نامگذاری، فاصله گذاری و ساختار کد را شامل می شود.

// Inconsistent formatting
if(condition){
    doSomething();
  } else {
      doSomethingElse();
}

// Consistent formatting
if (condition) {
    doSomething();
} else {
    doSomethingElse();
}

function calculateBookPrice(quantity, price) {
    return quantity * price;
}

function calculateLaptopPrice(quantity, price) {
    return quantity * price;
}

function calculateItemPrice(quantity, price) {
    return quantity * price;
}

const bookQuantity = 3;
const bookPrice = 25;

const laptopQuantity = 2;
const laptopPrice = 800;

const bookTotalPrice = calculateItemPrice(bookQuantity, bookPrice);
const laptopTotalPrice = calculateItemPrice(laptopQuantity, laptopPrice);

// Poor use of whitespace
const sum=function(a,b){return a+b;}

// Improved use of whitespace
const sum = function (a, b) {
    return a + b;
}

// Inadequate error handling
try {
    result = divide(x, y);
} catch (error) {
    console.error("An error occurred");
}

// Proper error handling
try {
    result = divide(x, y);
} catch (error) {
    if (error instanceof ZeroDivisionError) {
        console.error("Division by zero error:", error.message);
    } else if (error instanceof ValueError) {
        console.error("Invalid input:", error.message);
    } else {
        console.error("An unexpected error occurred:", error.message);
    }
}

// Example using JavaScript and the Jest testing framework
test('addition works correctly', () => {
    expect(add(2, 3)).toBe(5);
    expect(add(-1, 1)).toBe(0);
    expect(add(0, 0)).toBe(0);
});

function calculateTotalPrice(cartItems) {
    let totalPrice = 0;
    for (const item of cartItems) {
        totalPrice += item.price;
    }
    return totalPrice - (totalPrice * 0.1); // Apply a 10% discount
}

function calculateTotalPrice(cartItems, discountPercentage) {
    if (discountPercentage < 0 || discountPercentage > 100) {
        throw new Error("Discount percentage must be between 0 and 100.");
    }

    let totalPrice = 0;
    for (const item of cartItems) {
        totalPrice += item.price;
    }

    const discountAmount = (totalPrice * discountPercentage) / 100;
    return totalPrice - discountAmount;
}

منبع:dev.to