آموزشکدنویسی تمیز: نوشتن کد برای انسان ها یکی دیگر از آموزش های گروه آموزشی پرووید می باشد که در این قسمت آن را به شما معرفی می کنیم. این بسته ی آموزشی نیز یکی از دوره های آموزشی دیگر که در حوزه ی فارسی سازی آموزش های انگلیسی تنظیم شده است می باشد. عنوان این بسته ی آموزشی آموزش کدنویسی تمیز: نوشتن کد برای انسان ها است که با نام اصلی Clean Code: Writing Code for Humans از شرکت Pluralsight منتشر شده است.

کدنویسی تمیز(Clean Code) چیست؟

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

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

• قانون اول، این است که همواره ابزار مناسبی را برای کاری که می خواهید انجام بدهید استفاده کنید.
• قانون دوم، بهینه سازی کردن نرخ سیگنال به نویز و یا اصطلاحاً signal-to-noise ratio می باشند.
• نهایتاً قانون سوم، تلاش به نوشتن کد های خود مستند و یا self-documenting code می باشد.

برای نوشتن کد های تمیز، تکنیک های متفاوت و متنوعی معرفی شده اند که فارغ از هر زبان برنامه نویسی، می توانید از آنها استفاده کنید. در ادامه به صورت تیتروار به برخی از این تکنیک ها می پردازیم.

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

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

سرفصل مطالب آموزش کدنویسی تمیز: نوشتن کد برای انسان ها

فصل اول: مقدمه

• مقدمه
• کدنویسی تمیز چه اهمیتی دارد؟
• یک بنیاد
• ما نویسنده هستیم
• رسم و رسومات (Convention ها)
• منابع

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

• سه اصل هسته ای
• ابزار مناسب برای کار
• اهمیت مرزها: Native باقی بمانید
• شیطان بالقوه
• سیگنال نرخ Noise
• اصل DRY
• کدهای خود مستند شده
• جمع بندی

فصل سوم: نام گذاری

• مقدمه
• اهمیت نام گذاری
• کلاس ها
• متدها
• پدیده ی Rubber Ducking
• نشان های خطر
• عوارض
• اختصارها
• Boolean ها
• تقارن
• جمع بندی

فصل چهارم: جملات شرطی

• مقدمه
• مقایسه ی Boolean ها
• انتساب Boolean ها
• شرط های مثبت
• پدیده ی Ternary Elegance
• پدیده ی Stringly Typed
• پدیده ی Magic Numbers
• جملات شرطی پیچیده
• مقایسه ی Polymorphism و Enums
• Declarative عمل کنید
• متدهای مبتنی بر جدول
• جمع بندی

فصل پنجم: توابع

• مقدمه
• چه موقع یک تابع بنویسیم؟
• جلوگیری از تکرار کد
• حاشیه گذاری بیش از حد
• روش Extract Method
• روش Return Early
• روش Fail Fast
• مشخص کردن قصد تابع
• انجام دادن یک تک کار
• متغیرهای Mayfly
• پارامتر ها
• چقدر طولانی خیلی طولانی است؟
• استثناها
• جمع بندی

فصل ششم: کلاس ها

• مقدمه
• چه موقع یک کلاس بسازیم؟
• مبحث Cohesion
• یک کلاس چه موقع خیلی کوچک است؟
• پدیده ی Primitive Obession
• اصل Proximity
• قانون Outline
• جمع بندی

فصل هفتم: کامنت ها

• مقدمه
• نیاز و کمک گرفتن
• افزونگی
• قصد
• عذرخواهی ها و اخطارها
• کدهای Zombie
• استفاده از Divider و Brace Tracker
• پدیده ی Bloated Header
• پدیده ی Defect Log
• کامنت های تمیز
• جمع بندی

فصل هشتم: دمو

• مقدمه
• نگاه کلی به Registration
• معیارهای کد (Code Metrics)
• مبحث Automated Test
• کامنت ها
• متغیرهای Mayfly
• Guard Clause ها
• مسائل مربوط به نام گذاری
• روش Return Early
• ریفکتورکردن پرچم های قرمز
• منسجم کردن Guard ها و روشن کردن قصد
• روش متدهای مبتنی بر چدول و Fail Fast
• قانون Outline
• تست های Regression
• فیکس کردن باگ ها
• نتایج معیارهای کد و جمع بندی

فصل نهم: تمیز ماندن

• زمان مناسب برای ریفکتور کردن
• پنجره های شکسته
• مرور کد و Pair Programming
• قانون Boy Scout
• جمع بندی