Clean Code چیست؟ چگونه بنویسیم؟

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

Clean Code چیست؟

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

• فکر کردن باید ساده و اجرای آن ساده باشد. پرهیز از سردرگمی مهمترین ویژگی این مفهوم است.
• کد باید با در نظر گرفتن خود یا افرادی که بعد از شما کد را ویرایش می کنند به روشی به راحتی قابل ویرایش نوشته شود.
• کانسپت نوشته رابرت سیسیل مارتین "کد پاک" با کتاب همراه شد و از آنجا پدید آمد.

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

چگونه کد پاک بنویسیم؟

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

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

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

کد بد چیست؟

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

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

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

کلاسیک رابرت سیسیل مارتین "کد پاک" ما می توانیم در کتاب او به این مفهوم برسیم. متنی در کتاب وجود دارد که حتی کدهای بد هم می توانند کار کنند. بنابراین مفهوم بد کد ذکر شده است. با این حال، گفتن اینکه در حال حاضر در این موضوع اختلاف نظر وجود دارد، نباید خیلی سخت باشد. با توجه به اینکه اغلب با مفهوم "این کد بد است. ما باید آن را اصلاح کنیم" مواجه می شویم، واضح است که چنین مفهومی وجود دارد و باید در ادبیات گنجانده شود. بنابراین، آیا کد بو می دهد؟ بیایید این را بررسی کنیم.

Code Smells چیست؟

در ترکی با استعاره یعنی غیر تحت اللفظی می توان بیان بهتری داشت. آنقدر که این وضعیت ترکی ما را بسیار بهتر کرده و بیان را تقویت کرده است. اینجا کد بو می دهد، بنابراین بوی بد کد نیز نمونه ای از این موارد است. استعاره، اما توضیح عالی. خب، بوی کد چیست؟

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

چگونه بوهای کد را شناسایی کنیم؟

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

• تکراری (تکرار کد): اگر بخش های تکراری وجود داشته باشد معتبر است و می توانید این ساختار کد را کپی و جایگذاری کنید. همچنین ببینید: اصل خود را تکرار نکنید (DRY).
• ابهام: این مفهوم در صورتی جلب توجه می کند که کد نامفهوم و خواندن آن دشوار باشد.
• سختی: قابل تغییر نیست، حتی اگر تغییر کند، اگر مکان های زیادی تحت تأثیر قرار گیرد، معتبر است.
• کد مفصل (کد طولانی غیر ضروری): این مفهوم در صورتی معتبر است که کاری را که می توانید به روشی ساده تر انجام دهید، بیش از حد پیچیده کنید.

وقتی مفاهیم بالا و توضیحات آنها را به دقت بررسی کنید، به راحتی می توانید بوی کد را درک کنید.

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

سوالات متداول

ما چند سوال متداول در مورد کد پاک را برای شما گردآوری کرده ایم.