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

نمونه قبل و بعد در پایتون

# Before
f = lambda x, y: x * y * 0.9
# After
VIP_DISCOUNT_RATE = 0.10
def final_price(unit_price: int, quantity: int) -> float:
    subtotal = unit_price * quantity
    return subtotal * (1 - VIP_DISCOUNT_RATE)

نسخه دوم نیت کسب‌وکار را در نام‌ها روشن می‌کند. در برنامه واقعی پول بهتر است با نوع Decimal یا عدد صحیح در کوچک‌ترین واحد نگهداری شود.

نشانه‌ها در کد تیمی

اصلعلامت خوبمشکل رایج
نام‌گذارینام متناسب با دامنه سفارشنام مبهم data یا x
مسئولیتمتد با یک هدف روشنمتد بسیار بزرگ
وابستگیتزریق وابستگی آشکارفراخوانی پنهان سرویس سراسری
تست‌پذیریورودی و خروجی قابل کنترلاتکا به وضعیت سراسری

برای مرور بیشتر، مقاله خلاصه و نکات کلیدی کتاب کلین کد در باورژن را بخوانید.

اصطلاحات مرتبط: ریفکتورینگ، اصول سالید، بازبینی کد، بدهی فنی، یونیت تست.