چک لیست کدنویسی تمیز؟ مگه کدنویسی تمیز چیه یا اصلا چرا مهمه؟ امروزه کدنویسی چیزیه که خیلی‌ها از پس اون بر‌میان؛ اما هر کد‌ی خوانا و توسعه‌پذیر نیست. شاید علت این موضوع ساده‌پنداری کد‌نویسیه، شاید هم یدک‌کشیدن اسم کد‌نویس خیلی مهم شده. به همین دلیل الان کد‌نویسا‌ی زیاد‌ی وجود دارند؛ ولی کد‌نویس خوب و حرفه‌ای کم پیدا میشه.
شما چطور؟ شما هم دوست دارین کد‌نویس بشین؟ و یا تا حالا شده درباره‌اش رویا‌پردازی کنید؟ چطوره این بار با یه شروع قوی سراغ کار برید؟ برای شرکت در دوره آموزش پایتون کندو می‌تونید روی لینک کلیک کنید.
خب، اولین قدم، نوشتن یک کد تر و تمیزه. با یه کد سخت و پیچیده، امکان توسعه و رفع باگ دیگه معنی نداره. بنابراین مهمه کدایی که نوشته می‌شن ساده، قابل‌فهم، خوانا و یا تمیز باشن. این همون چیزیه که قراره امروز تو موسسه‌ی کندو به اون بپردازیم، یعنی چک لیست کدنویسی تمیز Clean Code؛ ولی بهتره اول بدونیم که کد تمیز دقیقا چه تعریفی داره؟
کد تمیز (Clean Code) چیست؟
تعاریف مختلفی از Clean Code شده. برنامه‌نویسا‌ی مختلف هر کدوم با توجه به تجربه‌ای که در کدنویسی دارن، ایده‌ها‌ی مختلفی رو ارائه دادن و میدن. اما از بین این تعاریف، کدوم درسته؟
به این سوال دقیق نمیشه جواب داد؛ اما چیز‌ا‌یی که بیشتر از همه به چشم میان، این عبارات هستن:
- خوانا
- توسعه‌پذیر
شاید بشه یه نتیجه‌ی منطقی گرفت. اینکه کد تمیز کدیه که یه پک کامل از این دو تا ویژگی باشه. تصور کنید که کد‌ی خوانا باشه؛ اما کارایی و توسعهپذیری نداشته باشه و یا حتی برعکس. بنابراین باید گفت که چک لیست کدنویسی تمیز یه لیست از تموم کاراییه که با انجام اونا میشه کد خوانا و قابل‌توسعه یا به عبارت دیگه کد تر و تمیز نوشت. حالا اگه ذهن شما برای آموزش Clean Code آماده شده، همین حالا چک لیست کدنویسی تمیز Clean Code رو شروع به مطالعه کنید و بعد اونا رو بطور عملی اجرایی کنید.
چک لیست کدنویسی تمیز Clean Code
این چک لیست یه لیست تمام و کمال از ویژگی‌ها‌یی هست که باید کد نویسی تمیز داشته باشن. به عبارت دیگه با مطالعه‌ی این بخش می‌تونید ضمن تشخیص کدای خوب و بد، خودتون هم با کسب مهارت تو مسائل گفته‌شده کدنویسی حرفه‌ای و خوبی رو انجام بدید. پس این شما و این چک لیست کدنویسی تمیز Clean Code.
برنامه‌ها را درست نام‌گذاری کنید
اولین ویژگی که باید تو چک لیست کدنویسی تمیز بهش توجه بشه، استفاده از اسامی درسته. اسامی پیچیده و بلند، بیشتر از اینکه راه‌گشا باشن، گیج‌کننده هستن. برای همین توصیه ما اینه که اسامی مختصر ولی کامل بهترین گزینه برای نام‌گذاری برنامه‌ها هستند. از جمله روش‌ها‌ی نام‌گذاری میشه به این موارد اشاره کرد:
- Kebab-case
- Pascal-case
- Snake-case
- Camel-case
اما حالا چرا اسم و نام‌گذاری تو برنامه‌نویسی مهمه؟ اسم و کلمات درست یه خوبی که داره، اینه که با وجود اونا دیگه لازم به نوشتن کامنتا‌ی اضافی نیست. پس با رعایت این موضوع کدای خود‌تونو تمیز بنویسید.
در برنامه کلاس‌ها‌ی بزرگ ننویسید
تو چک لیست کدنویسی تمیز Clean Code یکی از موارد‌ی که خیلی اهمیت داره، کلاس‌ها هستند. اگه کلاسی خیلی بزرگ باشه، چند تا معنا داره:
- اینکه کلاس بیش از اندازه کار می‌کنه
- اپلیکیشن درست و حسابی تقسیم نشده و یه جا‌ی کار می‌لنگه
- وابستگی بیش از حد کلاسا به همدیگه که توسعهپذیری کد‌ا رو خیلی کم می‌کنه
- اولین خصوصیتی که همین حالا تو چک لیست کدنویسی تمیز گفته شد رو یادتون موند؟ نام‌گذاری درست و دقیق. خود نام‌گذاری با وجود کلاسی که اندازه‌ی مناسبی نداره به مشکل بر‌می‌خوره.
- مهم‌تر از همه کد‌ا خونده نمی‌شن. در نتیجه کدنویسی، شلخته از آب در‌میاد.
راه‌حل این مشکلات چیه؟ اگه قصد دارید یه کد نویسی تمیز داشته باشید، می‌تونید از روشا‌ی پایین استفاده کنید:
- جدا‌کردن کلاسا
- طراحی دوباره
- ارث‌بری کلاس پدر
بیشتر بخوانیم: طراحی سایت با asp.net core بهتر است یا php؟
با یادگیری کد‌خوانی، کدنویسی خود‌تونو تقویت کنید
یکی دیگه از چیزا‌ی مهمی که تو چک لیست کدنویسی تمیز Clean Code توصیه میشه، یادگیری کد‌خوانی هست. حتما شنیدید که یه تعداد از کتاب‌خونا می‌گن: “وقت خودتون رو با خوندن کتابا‌ی بد تلف نکنید”. اگه به ما کندو‌یی‌ها باشه، می‌گیم که برعکس این کارو انجام بدید. شما به خوندن کتابا‌ی بد هم نیاز دارید؛ اما چرا؟ مهم‌ترین علتش اینه که با دیدن کتابا‌ی بد و تشخیص اشتباهات اونا می‌تونید کتابا‌ی خوب رو بهتر تشخیص بدید و یا حتی کتاب‌خون بهتر‌ی بشید.
این مثال درباره‌ی کد‌ا هم کاملا درسته. دیدن کدای بد می‌تونه مهارت شما رو بالا ببره و بعلاوه شما رو از اشتباهاتی که ممکنه در آینده اونا رو انجام بدید هم منع کنه. پس خودتون رو محدود نکنید. پیشرفت شما در نوشتن کد تمیز به نگاه و مهارت شما بستگی داره که باید با تمرین و توجه اونو گسترش بدید.
قوه تخیل خودتون رو پرورش بدید
شاید گفتن اینکه باید قوه تخیل‌تون رو تقویت کنید ، اون هم تو‌ی چک لیست کدنویسی تمیز Clean Code، برا‌تون عجیب به نظر بیاد؛ اما همین حالا دلیلشو توضیح می‌دیم. فرض کنید که شخصی قبل از شما کد‌ی نوشته و حالا توسعه‌ی اون به شما سپرده شده. حالا که به‌عنوان یه برنامه‌نویس نگاهی به کد‌ا می‌کنید، می‌فهمید که اصلا خوانا نیستن. چه حسی پیدا می‌کنید؟ جدا از احساس، کار شما برای توسعه‌دادن کدای نا‌خوانا خیلی سخته. اگه شما همچین تصور‌ی رو نسبت به برنامه‌نویس بعد‌ی که قصد توسعه و کار روی کد و برنامه شما داره، داشته باشید، به خودتون اجازه‌ی کد‌نگاریا‌ی پیچیده و نا‌مفهوم رو نمی‌دید. اینجوری با یه مرزبندی درست درباره Clean Code، خودتون رو از انجام کارا‌ی بی‌کیفیت منع می‌کنید. در نهایت با این تلاشا‌ی تدریجی به یه برنامه‌نویس حرفه‌ای تبدیل می‌شید.
طول توابع بیشتر از 25 تا 30 خط نشه
در چک لیست کدنویسی تمیز Clean Code که کندو اونو به شما ارائه می‌کنه، حتی به طول توابع هم پرداخته شده. با توابع کوچک، ماژول‌بندی راحت‌تره و بعلاوه Flow های برنامه هم تو‌ی ذهن بهتر انجام میشه. بذارید یکم بیشتر توضیح بدیم. توابع بزرگ، یعنی کار بیشتر که به تعداد زیاد‌ی ورودی نیاز داره. همه‌ی این عوامل ضمن مشکلاتی که برای خود‌شون دارند، باعث می‌شن که نام‌گذاری هم یه مشکلاتی پیدا کنه.
قوانین رو جدی بگیرین
یه چند تا قانون وجود داره که با اجرا‌ی اونا می‌تونید Clean Code طراحی کنین. این قوانین عبارت‌اند از:
قانونOpen/ Closed
این قانون یجورایی می‌گه که کارو به حد‌ی باید عالی انجام بدیم که بعدا نیاز‌ی به تغییر نداشته باشه، مگه اینکه قصد اضافه‌کردن چیز‌ی رو داشته باشیم. با وجود قانون Open/ Closed در چک لیست کدنویسی تمیز، کار توابع و کلاسا به حد‌ی دقیق انجام میشه که همیشه درست کار می‌کنند. پس این خصوصیت از چک لیست کدنویسی تمیز Clean Code رو فراموش نکنید.
قوانین DRY
قانون DRY یا Don’t Repeat Yourself یه قانون مشهوره که حتی تو برنامه‌نویسی هم جا برای خود‌ش باز کرده. تا جا‌یی که ممکنه نباید کد‌ی رو تکرار کنید. رعایت همین یه مورد می‌تونه یه کدنویسی تر و تمیز به شما بده. پس این قانون رو در چک لیست کدنویسی تمیز Clean Code دست کم نگیرید. اگه کد‌ی تکرار میشه، باید عین یه تابع تعریف بشه. در غیر اینصورت اگه کدای تکراری استفاده کرده باشید، باید برای تغییر فرمت ذخیره‌ی لاگ دوباره همون کد‌ا رو پیدا کنید و تغییرشون بدید. این کار احتمال اشتباها رو بیشتر می‌کنه و تو نوشتن Clean Code مشکل بوجود میاره.
کدها رو بطور مرتب ریفکتور کنید.
برای داشتن یه کد نویسی تمیز یا Clean Code بهتره علاوه‌بر نکات گفته‌شده تو چک لیست کدنویسی تمیز، بطور دوره‌ای هم کد‌ها‌ی نوشته‌شده رو ریفکتور کنید. با انجام این کار کد‌ا همیشه تو بهترین حالت خود‌شون هستن و مشکلات کم‌تر‌ی هم بوجود میاد. بعلاوه با خیال راحت از کارا‌ی قبلی هم همیشه می‌تونید کدای بهتر‌ی رو بنویسید و طراحی کنید.
سخن پایانی
کار برنامه‌نویسی بخصوص کد‌نگاری لازمه که با دقت انجام بشه. پس به هیچ وجه نباید تو انجام اون سهل‌انگاری کنیم. اهمیت یه کدنویسی تر و تمیز هم خیلی بیشتر از حفظ‌کردن Function کد‌ها‌ست. پس اگه می‌خواید یه برنامه‌نویس موفق بشید، اونو اصولی انجامش بدید و جمله معروف “کیفیت بهتر از کمیت” رو جدی بگیرید. چک لیست کدنویسی تمیز Clean Code که توسط کندو ارائه شد، تنها یه نگاه جزئی به مبحث گسترده‌ی کد‌نگاری تمیزه؛ اما یه شروع خوبه. با موسسه کندو حتی می‌تونید فرا‌تر هم برید و به یه برنامه‌نویس فوق‌حرفه‌ای تبدیل بشید.
