بتل کد Battle Codeدارد باز می‌شود…

کد خوب و بد

برنامه‌نویس‌ها برای کدِ بد اسم‌های بامزه‌ای دارند: اسپاگتی، بو، مرده، جادو. این اسم‌ها را بیشتر در بازبینی کد می‌شنوی.

صفت‌هایی با ‎-ed

شکل سوم فعل می‌تواند مثل صفت پیش از اسم بنشیند و بگوید «چه کاری رویش انجام شده»: a hard-coded path (مسیری که سفت در کد نوشته شده)، a named constant (ثابتی که اسم گرفته)، nested ifs (ifهای تودرتو شده). هر جا در مستندات کلمه‌ای با ‎-ed پیش از یک اسم دیدی، همین‌طور بخوانش.

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

technical debt (تِکنیکال دِت): بدهی فنی؛ هزینه‌ی راه‌حل‌های عجله‌ای

debt یعنی بدهی و قرض. وقتی برای زود رسیدن، راه سریع و سرهم‌بندی را انتخاب می‌کنی، انگار از آینده قرض گرفته‌ای: امروز زود تمام می‌شود، ولی بعداً هر تغییری در آن کد سخت‌تر و کندتر است. این «بهره» را آن‌قدر می‌دهی تا روزی بنشینی و کد را درست کنی. این تشبیه را Ward Cunningham، یکی از برنامه‌نویس‌های قدیمی، ساخت.

We need a sprint to pay down some technical debt.

یک اسپرینت لازم داریم تا بخشی از بدهی فنی را صاف کنیم.

spaghetti code (اِسپاگِتی کُد): کد درهم و گره‌خورده

یک بشقاب اسپاگتی را تصور کن: سر یک رشته را بکشی، نمی‌دانی تهش کجاست و چه چیزهایی با آن تکان می‌خورند. spaghetti code هم همین است: ifهای تودرتو، تابع‌های چندصدخطی و متغیرهایی که از همه‌جا عوض می‌شوند. کار می‌کند، ولی هیچ‌کس جرئت دست زدن به آن را ندارد.

This file is pure spaghetti code, nobody wants to touch it.

این فایل اسپاگتی خالص است، هیچ‌کس نمی‌خواهد به آن دست بزند.

legacy code (لِگِسی کُد): کد قدیمیِ به‌ارث‌رسیده

legacy یعنی میراث، چیزی که از قبلی‌ها به تو رسیده است. legacy code کدی قدیمی است که کس دیگری سال‌ها پیش نوشته، هنوز هر روز کار می‌کند و کارهای مهمی هم روی دوشش است، ولی با ابزارها و سبک قدیم نوشته شده و معمولاً تست و مستندات درستی ندارد. نمی‌شود دورش انداخت و عوض کردنش هم ترسناک است.

Be careful, the billing module is legacy code with no tests.

مراقب باش، ماژول صورت‌حساب کد قدیمی است و هیچ تستی ندارد.

clean code (کلین کُد): کد تمیز و خوانا

clean یعنی تمیز. clean code کدی است که نفر بعدی، یا خودت شش ماه بعد، بدون زحمت آن را بخواند و بفهمد: اسم‌های روشن، تابع‌های کوتاه که هر کدام یک کار می‌کنند، و بدون تکرار. کامپیوتر با کد کثیف هم کار می‌کند؛ کد تمیز برای آدم‌هاست. Clean Code اسم یک کتاب معروف از Robert C. Martin هم هست.

Good names are the first step toward clean code.

اسم‌های خوب اولین قدم به سوی کد تمیز است.

code smell (کُد اِسمِل): بوی بد کد؛ نشانه‌ی یک مشکل پنهان

smell یعنی بو. وقتی از یخچال بوی بدی می‌آید، هنوز نمی‌دانی چه چیزی خراب شده، ولی می‌دانی باید بگردی. code smell هم باگ نیست و برنامه با آن کار می‌کند؛ نشانه‌ای است که می‌گوید طراحی این‌جا احتمالاً ایراد دارد. مثل تابعی با ده ورودی، یا یک تکه کد که سه جا کپی شده است. این اصطلاح را Kent Beck سر زبان‌ها انداخت.

A function with ten parameters is a code smell.

تابعی با ده پارامتر نشانه‌ی یک مشکل در کد است.

dead code (دِد کُد): کد مرده؛ کدی که هیچ‌وقت اجرا نمی‌شود

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

I removed 200 lines of dead code from the old API.

دویست خط کد مرده را از API قدیمی پاک کردم.

hard-coded (هارد کُدِد): مستقیم در کد نوشته‌شده (به جای تنظیمات)

hard این‌جا یعنی سفت و ثابت. مقدار hard-coded مقداری است که مستقیم وسط کد نوشته شده، به جای این‌که از تنظیمات، ورودی یا یک متغیر بیاید: نشانی سرور، رمز، اسم یک پوشه روی کامپیوتر خودت. تا وقتی هیچ‌چیز عوض نشود کار می‌کند؛ روزی که عوض شد، باید کد را بگردی و دانه‌دانه دست بزنی.

The server address is hard-coded, so it only works on my laptop.

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

magic number (مَجیک نامبِر): عدد بی‌نام و بی‌توضیح وسط کد

magic یعنی جادو. magic number عددی است که بی هیچ اسم و توضیحی وسط کد نشسته و مثل جادو کار را راه می‌اندازد، ولی کسی نمی‌داند چرا همین عدد: 86400؟ 0.09؟ 7؟ راهش این است که عدد را در یک ثابت با اسم روشن بگذاری تا خواننده معنایش را بفهمد و برای عوض کردنش فقط یک جا را دست بزند.

Please replace this magic number with a named constant.

لطفاً این عدد بی‌نام را با یک ثابتِ اسم‌دار عوض کن.

نظرهای یک بازبین

Thanks for the PR! A few comments:

1. The tax rate 0.09 is a magic number. Please move it to a named constant.
2. The file path is hard-coded, so this will not work on the server.
3. The function old_export is dead code now. Nothing calls it, so you can delete it.
4. Six levels of nested ifs is a code smell. Can you split it into two functions?

I know this module is legacy code and you did not write it. But every small fix pays down a little technical debt.

ممنون بابت PR! چند نظر:

۱. نرخ مالیات 0.09 یک عدد بی‌نام است. لطفاً آن را در یک ثابتِ اسم‌دار بگذار.
۲. مسیر فایل مستقیم در کد نوشته شده، پس روی سرور کار نمی‌کند.
۳. تابع old_export حالا کد مرده است. هیچ‌جا صدا زده نمی‌شود، پس می‌توانی پاکش کنی.
۴. شش لایه if تودرتو نشانه‌ی یک مشکل است. می‌توانی آن را به دو تابع بشکنی؟

می‌دانم این ماژول کد قدیمی است و تو آن را ننوشته‌ای. ولی هر اصلاح کوچک، کمی از بدهی فنی را صاف می‌کند.