ضروری باش!!
TL;DR: توابع با نام های نامشخص، قصد را پنهان می کنند و خوانندگان را گیج می کنند. از نام های توصیفی و عمل محور استفاده کنید.
مشکلات
- هدف عملکرد نامشخص
- افزایش بار شناختی
- زمینه گمراه کننده
- کاهش خوانایی
- همکاری دشوار
- قابلیت پنهان
راه حل ها
- از افعال عمل گرا استفاده کنید
- نام ها را توصیفی بسازید
- هدف تابع را منعکس کنید
- از اصطلاحات عمومی اجتناب کنید
- زمینه معنادار را فراهم کنید
- مسئولیت واحد را به وضوح بیان کنید
- عمل را با نتیجه مطابقت دهید
Refactorings
https://hackernoon.com/improving-the-code-one-line-at-a-time
زمینه
توابعی که با اصطلاحات عمومی نامگذاری شده اند، خوانندگان را وادار می کنند تا برای درک رفتار خود، در پیاده سازی فرو روند.
این باعث اتلاف وقت و افزایش احتمال خطا می شود.
هنگام کار با توابع مستقل، جایی که نام کلاس زمینه اضافی را ارائه نمی کند، نامگذاری حتی مهم تر می شود.
این موضوع مستقیماً به بگو اصل نپرس.
به جای افشای رفتارهای مبهم که تماس گیرنده را مجبور به استنباط عملکرد می کند، نام های ضروری عمل دقیق را منتقل می کنند و خواننده را بدون نیاز به بازرسی کد راهنمایی می کنند.
وقتی توابع را به صورت توصیفی نامگذاری می کنید، حدس و گمان های غیر ضروری را حذف می کنید و با این اصل هماهنگ می شوید.
کد نمونه
اشتباه است
public String dateFormatting(Date date) {
return new...