احتمالاً قبلاً این مورد را شنیده اید: “از آنچه که آن را پیدا کردید ، پاک کننده اردوگاه را ترک کنید.”
خوب ، تعجب آور – این فقط توصیه خوبی برای بیرون از منزل نیست. همچنین این مشاوره محکم برای نوشتن کد است. و بله ، یک نام دارد: قانون پیشاهنگ پسربشر
🧼 چیست؟
قانون ساده است: هر بار که مقداری کد را لمس می کنید ، آن را کمی بهتر از آنچه بودبشر
لازم نیست کل پروژه را مجدداً مورد استفاده قرار دهید یا به طور کامل DDD (درام دامنه محور) بروید. این نکته نیست. این در مورد چیزهای کوچک است.
اگر متغیری به نام مشاهده می کنید a این در واقع یک است userId، آن را تغییر نام دهید.
اگر بر روی یک عملکرد 200 خط گیر می کنید و می توانید 10 خط را در یک یاور استخراج کنید-آن را انجام دهید.
اگر از سال 2019 یک TODO وجود دارد که اکنون منسوخ شده است – آن را حذف کنید.
مثل مسواک زدن دندان های خود است. هیچ کس شما را برای آن مهمانی نمی کند ، اما اگر این کار را نکنید … همه چیز سریع زشت می شود.
🤔 چرا باید اهمیت دهید؟
زیرا شما تنها کسی نیستید که آن کد را می خواند. و خود آینده شما؟ آنها از شما تشکر می کنند که مین های زمینی را پشت سر نگذارید.
بدهی فنی به سرعت ایجاد می شود و این قانون روشی کم کار برای مبارزه با آن است.
اگر همه افراد در تیم شما بهبود می یابند فقط کمی از کدی که هر روز لمس می کنند ، پایگاه کد به جای پوسیدگی تکامل می یابد.
🛠 نحوه اعمال آن در Node.js
بیایید عملی شویم. شما در حال کار بر روی یک پروژه Node.js هستید و باید یک اشکال را برطرف کنید یا یک ویژگی را اضافه کنید. قبل از بستن پرونده ، از خود بپرسید:
- آیا می توانم این عملکرد گیج کننده را تغییر نام دهم؟
- آنجاست
console.logبیانیه هایی که باید تمیز کنم؟ - این است
async/awaitاسپاگتی که می تواند استفاده کند.catch()؟ - آیا می توانم یک نظر مفقود را اضافه کنم که به Dev بعدی کمک کند؟
🔍 قبل
function d(a, b) {
return a + b;
}
🔍 بعد از
function sumPrices(priceA, priceB) {
return priceA + priceB;
}
thoughts افکار نهایی
قانون پسر پیشاهنگ یک چارچوب ، کتابخانه یا الگوی طراحی فانتزی نیست.
این یک طرز فکر است.
اینگونه است که شما به آرامی یک پایگاه کد کثیف را بهبود می بخشید بدون اینکه همه چیز را متوقف کنید و “همه آن را تمیز کنید”.
بنابراین دفعه بعد که یک فایل را لمس می کنید ، فقط اشکال را برطرف نکنید یا ویژگی را اضافه نکنید.
یک کار خوب را برای Dev بعدی انجام دهید (حتی اگر این Dev در 3 ماه باشد).
Refactor آن حلقه عجیب و غریب.
آن متغیر مبهم را تغییر نام دهید.
Delte که 2018 همه چیز.
فقط اردوگاه را کمی تمیزتر از آنچه پیدا کردید ، درست کنید.
