آیا تا به حال پیش آمده که به کدی که چند ماه پیش خودتان نوشتهاید نگاه کنید و از خودتان بپرسید: «اینجا چه خبر است؟» یا بدتر از آن، مجبور شده باشید کدهای پیچیده و درهمریخته یک همکار را توسعه دهید؟ اگر پاسختان مثبت است، شما با اهمیت «کد تمیز» (Clean Code) از نزدیک آشنا شدهاید.
کدنویسی فقط به این معنا نیست که به کامپیوتر بگوییم چه کاری انجام دهد. بخش بزرگی از کار ما نوشتن کدی است که انسانهای دیگر (و خود آیندهمان!) بتوانند آن را بخوانند، درک کنند و به راحتی توسعه دهند.
در این مقاله، به زبان ساده بررسی میکنیم که کد تمیز چیست، چرا یک سرمایهگذاری حیاتی برای هر برنامهنویسی محسوب میشود و چگونه میتوانید با چند اصل ساده، کیفیت کار خود را متحول کنید.
رابرت سی. مارتین (عمو باب)، نویسنده کتاب مشهور «کد تمیز»، میگوید: «کدی که تمیز نیست، هزینه نگهداری بالایی دارد و توسعه آن عذابآور است.»
بیایید صادق باشیم، ما زمان بسیار بیشتری را صرف خواندن کد میکنیم تا نوشتن آن. یک کد تمیز و خوانا مانند یک کتاب خوشخوان است؛ به راحتی شما را در جریان داستان قرار میدهد. اما یک کد کثیف و پیچیده، مانند یک متن ناخوانا و پر از غلط است که درک آن انرژی و زمان زیادی از شما میگیرد.
مزایای اصلی کدنویسی تمیز:
نگهداری و توسعه آسانتر: پیدا کردن باگها و افزودن ویژگیهای جدید به کدی که ساختار منظمی دارد، بسیار سریعتر و کمهزینهتر است.
کاهش باگها: کدهای خوانا و ساده، احتمال بروز خطاهای منطقی را کاهش میدهند، چون درک جریان برنامه آسانتر است.
همکاری تیمی بهتر: وقتی کد شما برای همکارانتان قابل فهم باشد، کار تیمی روانتر و مؤثرتر میشود.
صرفهجویی در زمان و هزینه: شاید در ابتدا برای نوشتن کد تمیز کمی بیشتر زمان بگذارید، اما در بلندمدت، این کار با کاهش هزینههای نگهداری و دیباگ، سودآوری پروژه را به شدت افزایش میدهد.
تبدیل شدن به یک برنامهنویس که کد تمیز مینویسد، یک شبه اتفاق نمیافتد، بلکه یک عادت و یک ذهنیت است. در اینجا چند اصل کلیدی وجود دارد که میتوانید از همین امروز شروع به پیادهسازی آنها کنید.
این مهمترین و سادهترین قانون است. نام متغیرها، توابع و کلاسها باید هدف آنها را به وضوح بیان کنند.
بد: let d; // d چیست؟ روز؟ داده؟ یک متغیر حذف شده؟
خوب: let elapsedTimeInDays;
بد: function processData(data) { ... } // چه کاری روی داده انجام میدهد؟
خوب: function validateAndSaveUser(userData) { ... }
از نامهای تکحرفی یا اختصارات مبهم پرهیز کنید، مگر در موارد بسیار شناختهشده (مانند i برای شمارنده حلقه).
یک تابع خوب فقط و فقط یک کار انجام میدهد و آن را به خوبی انجام میدهد. اگر نمیتوانید در یک جمله کوتاه و واضح توضیح دهید که یک تابع چه کاری میکند، احتمالاً آن تابع بیش از حد طولانی و پیچیده است و باید به توابع کوچکتر تقسیم شود.
قانون سرانگشتی: یک تابع در حالت ایدهآل نباید بیشتر از ۱۰-۱۵ خط باشد.
شاید این توصیه عجیب به نظر برسد، اما یک باور رایج در میان برنامهنویسان حرفهای وجود دارد: کد باید خودش گویای عملکردش باشد.
به جای نوشتن کامنت برای توضیح یک قطعه کد پیچیده، سعی کنید خودِ کد را آنقدر ساده و خوانا بازنویسی کنید که نیازی به توضیح نداشته باشد. کامنتها را برای توضیح چرایی یک تصمیم (مثلاً یک راه حل غیرمتعارف برای یک باگ خاص) یا هشدارها نگه دارید، نه برای توضیح «چه کاری» انجام میشود.
نمونه اشتباه:
// این متغیر وضعیت کاربر را نگه میدارد let s = 1;
نمونه درست:
let isUserActive = true;
اصل DRY (Don't Repeat Yourself) یکی از ستونهای اصلی مهندسی نرمافزار است. اگر یک قطعه کد را در چند جای مختلف کپی و پیست میکنید، در حال نقض این اصل هستید.
به جای تکرار، آن منطق را در یک تابع یا کلاس جداگانه قرار دهید و از آن در هر جایی که نیاز دارید، استفاده کنید. این کار باعث میشود که در صورت نیاز به تغییر، فقط یک مکان را ویرایش کنید و از بروز باگهای ناشی از ناهماهنگی جلوگیری شود.
کدنویسی تمیز فقط یک مهارت فنی نیست، بلکه نشاندهنده احترام شما به همکاران، پروژه و مهمتر از همه، به خودتان در آینده است. دفعه بعدی که در ویرایشگر کد خود هستید، لحظهای مکث کنید و از خود بپرسید: «آیا این کد به اندازه کافی خوانا و ساده است؟ آیا کسی که ۶ ماه دیگر آن را میخواند، به راحتی آن را درک خواهد کرد؟»
با تمرین مداوم این اصول، نه تنها به برنامهنویس بهتری تبدیل میشوید، بلکه از فرآیند ساخت نرمافزار نیز لذت بیشتری خواهید برد.
