مطالعه و بازبینی کدنویسی تمیز مثل راه رفتن در یک اتاق مرتب و منظم است که هر چیزی سر جای خودش قرار گرفته و دسترسی به آنها براحتی و در کوتاه ترین زمان ممکن امکان پذیر است.

همچنین بخوانید» آموزش اندروید استودیو | آموزش نصب Android Studio | اندروید استودیو چیست؟

کدنویسی تمیز چگونه ابداع شد؟

ایده‌ی کدنویسی تمیز، توسط آقای رابرت سی مارتین (Robert C. Martin) که اصطلاحا عمو باب هم به ایشون گفته میشه، به وجود اومد. ایشون یه برنامه‌نویس با سابقه‌ای هستند و طی سال‌ها بررسی در کدهای مختلف، به این نتیجه میرسند که نوشتن کدهای قابل فهم و خوانا یه مساله و موضوع مهمی در حوزه‌ی توسعه نرم‌افزار هستش، از این رو تصمیم به انتشار دانسته‌های خودشون می‌گیرین و کتا‌ب‌های مختلفی در حوزه‌ی توسعه نرم‌افزار تألیف می‌کنند که یکی از محبوب‌ترین این کتاب‌ها، کتاب Clean Code هستش، که در اون به اصول کدنویسی تمیز پرداخته شده.

چرا باید از اصول کدنویسی تمیز پیروی کنیم؟

برای کامپیوتر فرقی نمی‌کند که کد شما تمیز است یا نه! برای کامپیوتر فقط یه سری قواعد منطقی و دستوری مثل سینتکس مهم است که رعایت شوند و کاری به این چیزها ندارد.

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

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

“هر کسی می تواند کدی بنویسد که یک کامپیوتر بتواند آن را بفهمد. برنامه نویسان خوب کدهایی را می نویسند که انسان ها می توانند آن را بفهمند.” – مارتین فاولر

نمونه های کدنویسی تمیز کدامند؟

نمونه های زیادی از کدنویسی تمیز در دسترس است. برخی از نمونه ها عبارتند از:

• کتابخانه های استاندارد زبان: کتابخانه های استاندارد زبان اغلب دارای کد تمیز و قابل نگهداری هستند. به عنوان مثال، کتابخانه استاندارد زبان Python شامل کدی است که خوانا، قابل نگهداری و قابل توسعه است.
• پروژه های منبع باز: بسیاری از پروژه های منبع باز دارای کد تمیز هستند که می توانید از آن به عنوان نمونه استفاده کنید. به عنوان مثال، پروژه منبع باز Django شامل کدی است که خوانا، قابل نگهداری و قابل توسعه است.
• کد شخصی خود: می توانید کد شخصی خود را به عنوان نمونه استفاده کنید. با گذشت زمان و تجربه، می توانید کد خود را تمیزتر و قابل نگهداری تر کنید.

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

نحوه نامگذاری متغیرها 

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

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

نحوه ایجاد نام های معنی دار

از کامنت ها برای توضیح اینکه چرا از یک متغیر استفاده شده است استفاده نکنید. اگر نامی نیاز به کامنت و توضیحات دارد، باید زمان خود را صرف تغییر نام آن متغیر به جای نوشتن کامنت کنید.

“یک نام گذاری خوب باید به شما بگوید که چرا وجود دارد، چه کار می کند، و چگونه استفاده می شود. اگر نامی نیاز به کامنت داشته باشد، آن نام هدف خود را نشان نمی دهد.

نامگذاری بد:

var d; // elapsed time in days

این مدل کد بارها دیده شده و این یک تصور غلط رایج است که شما باید با کامنت خود را پنهان کنید. از حروفی مانند x، y، a یا b به عنوان نام متغیرها استفاده نکنید، مگر اینکه دلیل خوبی وجود داشته باشد (متغیرهای loop از این استثنا هستند).

نام گذاری تمیز:

var elapsedTimeInDays;

var daysSinceCreation;

var daysSinceModification;

این نام گذاری خیلی بهتر به شما می گویند که چه چیزی اندازه گیری می شود و واحد اندازه گیری آن چیست.

از اطلاعات نادرست پرهیز کنید

مراقب کلماتی که معنی خاصی دارند باشید. به گروه بندی حساب ها به عنوان accountList اشاره نکنید مگر اینکه نوع آن در واقع یک لیست باشد. این کلمه معنای خاصی دارد و ممکن است به نتایج نادرستی منجر شود.

حتی اگر نوع یک لیست باشد، accounts نام ساده‌تر و بهتری است.

کد نویسی بد:

var accountList = [];

کد نویسی تمیز:

var accounts = []

از کلمات نویز استفاده نکنید

کلمات نویز کلماتی هستند که هیچ اطلاعات اضافی در مورد متغیر ارائه نمی دهند و در واقع اضافی هستند و باید حذف شوند.

برخی از کلمات نویز عبارتند از:

• The (prefix)
• Info
• Data
• Variable
• Object
• Manager

اگر کلاس شما UserInfo نام دارد، فقط می توانید اطلاعات را حذف کرده و آن را کاربر کنید. استفاده از BookData به‌جای Book به‌عنوان نام کلاس، کار ساده‌ای نیست، زیرا به هر حال یک کلاس داده‌ها را ذخیره می‌کند.

از نام های قابل جستجو استفاده کنید

از استفاده از اعداد جادویی در کد خود اجتناب کنید. ثابت های قابل جستجو و نامگذاری شده را انتخاب کنید. از نام های تک حرفی برای ثابت ها استفاده نکنید زیرا می توانند در بسیاری از جاها ظاهر شوند و بنابراین به راحتی قابل جستجو نیستند.

نام گذاری بد:

if (student.classes.length < 7) {

// Do something

}

نام گذاری تمیز: 

if (student.classes.length < MAX_CLASSES_PER_STUDENT) {

// Do something

}

این گزینه بهتر است زیرا MAX_CLASSES_PER_STUDENT را می توان در بسیاری از مکان ها در کد استفاده کرد. اگر بخواهیم در آینده آن را به ۶ تغییر دهیم، فقط می توانیم ثابت را تغییر دهیم.

مثال بد در ذهن خواننده علامت سوال ایجاد می کند، مثلا اهمیت ۷ چیست؟

همچنین باید از قراردادهای نامگذاری و اعلان ثابت زبان خود مانند private static final در جاوا یا const در جاوا اسکریپت استفاده کنید.

توجه کنید: 

برای هر قانون مفهومی یک کلمه را دنبال کنید. از fetch, retrieve, and get  برای یک عملیات در کلاس های مختلف استفاده نکنید. یکی از آنها را انتخاب کنید و از آن در سراسر پروژه استفاده کنید تا افرادی که codebase یا API مشتریان شما را حفظ می کنند بتوانند به راحتی روش های مورد نظر خود را پیدا کنند.

همچنین بخوانید: برنامه Open Source چیست؟

نحوه نوشتن توابع برای داشتن کدنویسی تمیز

توابع را کوچک نگه دارید

توابع باید خیلی کوچک باشند. آنها حداکثر بهتر است ۲۰ خط داشته باشند. هر چه یک عملکرد طولانی تر شود، احتمال اینکه چندین کار را انجام دهد و عوارض جانبی داشته باشد، بیشتر می شود.

مطمئن شوید که توابع فقط یک کار را انجام می دهند

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

گاهی اوقات سخت است که به عملکرد نگاه کنید و ببینید که آیا چندین کار را انجام می دهد یا خیر. یک راه خوب برای بررسی این است که سعی کنید دیگر توابع را با نام متفاوتی اکسترکت کنید. اگر بتوانید آن را پیدا کنید، به این معنی است که باید عملکرد متفاوتی داشته باشد. کمی زمان می برد تا به آن عادت کنید. اما هنگامی که آن را به دست آورید، کد شما بسیار بهتر تر به نظر می رسد، و مطمئناً راحت تر، قابل درک تر و تست شده خواهد بود.

همچنین بخوانید: کراس پلتفرم چیست؟ 

کپسوله کردن شرایط در توابع

ریفکتورینگ شرط و قرار دادن آن در یک تابع نامگذاری شده، راه خوبی برای خوانایی بیشتر شرط های شما است.

نتیجه گیری از آموزش کدنویسی تمیز یا Clean Code