5 روش کد پاک که هر مهندس نرم افزار باید از آن پیروی کند
مهندسی نرم افزار یک فرآیند پیچیده است که نیاز به تخصص و توجه زیادی به جزئیات دارد. نوشتن کد تمیز می تواند به مدیریت بیشتر مهندسی نرم افزار کمک کند. ایجاد نرم افزار با کدی که درک، اصلاح و نگهداری آن آسان باشد، ضروری است. کد پاک نه تنها برای تعمیر و نگهداری بسیار مهم است، بلکه کارآمدتر، آزمایش آسان تر و ایمن تر است.
در این مقاله، ما 5 روش کد تمیز را که هر مهندس نرم افزار باید دنبال کند، بیان می کنیم.
1. برای انسان ها کد بنویسید نه فقط ماشین ها
یکی از اقدامات ضروری کد پاک، نوشتن کد برای انسان است. به راحتی می توان فراموش کرد که کدی که می نویسید فقط برای تفسیر ماشین ها نیست، بلکه برای انسان ها برای خواندن و درک آن است. نوشتن کدی ضروری است که خواندن، درک و اصلاح آن آسان باشد.
در اینجا چند نکته برای نوشتن کدی وجود دارد که تفسیر آن برای انسان آسان باشد:
-
از نام های معنی دار متغیرها و توابع استفاده کنید: نام متغیرها و توابع باید خود توضیحی باشد. از استفاده از نام های مبهم یا گمراه کننده خودداری کنید، زیرا باعث سردرگمی برنامه نویسانی می شود که کد را می خوانند.
-
استفاده از نظرات برای شفاف سازی کد: از نظرات برای خوانایی بیشتر کد استفاده کنید و توضیح دهید که کد چه کار می کند.
-
از عبارات پیچیده اجتناب کنید: درک کدهای پیچیده سخت است. عبارات پیچیده را به عبارات کوچکتر و خواناتر تقسیم کنید.
-
کد را به سبکی ثابت بنویسید: سبک کدنویسی یکنواخت کد را خواناتر و درک آن آسان تر می کند.
2. کد را خشک نگه دارید (خودتان را تکرار نکنید)
تکرار کد یک اتفاق رایج در مهندسی نرم افزار است. حفظ کدهای تکراری نه تنها چالش برانگیزتر است، بلکه مستعد خطا نیز است. تکرار یک کد در چندین توابع یا ماژول نشانه این است که مشکلی در طراحی کلی وجود دارد.
اصل خودت را تکرار نکن (DRY) یک الگوی طراحی نرم افزاری است که هدف آن کاهش تکرار کد است. اصل DRY بیان می کند که هر دانشی باید یک بازنمایی واحد، بدون ابهام و معتبر در یک سیستم داشته باشد.
در اینجا چند نکته برای حفظ کد DRY وجود دارد:
-
استخراج کدهای رایج به توابع یا ماژول ها: وقتی متوجه شدید که یک کد را بارها و بارها تکرار می کنید، زمان آن رسیده که آن را در یک تابع یا ماژول انتزاع کنید.
-
استفاده از وراثت یا ترکیب: استفاده مجدد از کد از طریق وراثت یا ترکیب به جای کپی و چسباندن کد.
-
اجتناب از ثابت های رمزگذاری شده: کدگذاری مقادیر در کد باعث می شود انعطاف پذیری کمتری داشته باشد. استخراج ثابت ها به یک مخزن پیکربندی مرکزی.
3. اندازه و پیچیدگی عملکرد را محدود کنید
توابع باید مختصر باشند و فقط یک کار را انجام دهند. خواندن، آزمایش و نگهداری توابع طولانی و پیچیده دشوار است. تقسیم توابع به توابع کوچکتر نه تنها کد را قابل مدیریت تر، بلکه ماژولارتر می کند.
در اینجا چند نکته برای محدود کردن اندازه عملکرد و پیچیدگی وجود دارد:
-
توابع کوتاه را هدف بگیرید: هر تابع را کوتاه و روی یک کار متمرکز کنید. توابع کوتاه به راحتی قابل درک و آزمایش هستند.
-
کاهش تودرتو: از کدهای بیش از حد تو در تو خودداری کنید، زیرا خواندن آن چالش برانگیزتر است. راه هایی برای مسطح کردن ساختار کد با refactoring پیدا کنید.
-
کاهش پارامترها: استفاده از توابعی که پارامترهای زیادی دارند سخت است. تعداد پارامترهای تابع را به سه یا کمتر محدود کنید.
-
اجتناب از متغیرهای سراسری: متغیرهای جهانی می توانند درک و آزمایش کد را دشوار کنند. آنها همچنین می توانند با عملکردهای دیگر در کد تداخل داشته باشند.
4. کد قابل تست بنویسید
تست یکی از جنبه های مهم مهندسی نرم افزار است. ضروری است که اطمینان حاصل شود که نرم افزار قبل از انتشار همانطور که انتظار می رود کار می کند. نوشتن کد قابل آزمایش کمک می کند تا فرآیند تست قابل کنترل تر و دقیق تر شود.
در اینجا چند نکته برای نوشتن کد قابل آزمایش وجود دارد:
-
از تکنیک های برنامه نویسی تابعی استفاده کنید: توابعی را بنویسید که بر اساس ورودی هایشان نتایج قابل پیش بینی و قطعی تولید کنند.
-
از تزریق وابستگی استفاده کنید: برای بهبود تست پذیری، وابستگی ها را به توابع تزریق کنید.
-
از استفاده از روش‌های استاتیک اجتناب کنید: روش‌های استاتیک می‌توانند برای آزمایش مشکل ساز باشند، زیرا نمی‌توان آنها را مسخره کرد یا به آنها ضربه زد.
-
اجتناب از وضعیت جهانی: وضعیت جهانی می تواند برای آزمایش مشکل ساز باشد. در صورت امکان ترجیح دهید از حالت محلی استفاده کنید.
5. از سیستم کنترل نسخه استفاده کنید
سیستم های کنترل نسخه (VCS) مانند Git ابزارهای ضروری برای توسعه نرم افزار هستند. VCS مدیریت تغییرات کد و جداسازی مسائل در کد را آسان تر می کند. VCS همچنین با اجازه دادن به چندین توسعه دهنده برای کار همزمان روی یک پایگاه کد به همکاری کمک می کند.
در اینجا چند نکته برای استفاده از سیستم کنترل نسخه وجود دارد:
-
ایجاد شاخه‌ها: ایجاد شاخه‌ها کار بر روی ویژگی‌های جدید یا رفع اشکال را آسان‌تر می‌کند بدون اینکه بر پایگاه کد اصلی تأثیر بگذارد.
-
commit به طور منظم: commit کردن اغلب ردیابی تغییرات کد و بازگشت به نسخه های قبلی را در صورت وجود مشکل آسان تر می کند.
-
Write Descriptive Commit messages: پیام های commit بنویسید که تغییرات ایجاد شده در کد را توضیح می دهد.
-
آموزش استفاده از دستورات VCS: یاد بگیرید چگونه از دستورات VCS برای مدیریت تاریخچه کد استفاده کنید.
نتیجه
نوشتن کد تمیز برای توسعه نرم افزار ضروری است. درک، اصلاح، نگهداری و آزمایش کد پاک آسان‌تر است. اقدامات ذکر شده در این مقاله به شما کمک می کند تا کد تمیزی بنویسید که کارآمدتر، ایمن تر و نگهداری آسان تر باشد. به یاد داشته باشید که کد را DRY نگه دارید، کد قابل آزمایش بنویسید، پیچیدگی عملکرد را محدود کنید و از سیستم های کنترل نسخه استفاده کنید. همچنین، به یاد داشته باشید که برای انسان ها کد بنویسید، نه فقط ماشین ها.
