از نامگذاری مبهم برای متغیرهای مسیر اجتناب کنید
مشکلات
- هدف متغیر نامشخص
- خطای بیجکشن
- زمینه گمراه کننده
- کد تکراری
- نگهداری سخت تر
- کاهش خوانایی
- اختصارات
- افزایش بار شناختی
راه حل ها
- به Bijection احترام بگذارید
- از اسامی دقیق استفاده کنید
- از ابهام بپرهیزید
- زمینه را روشن نگه دارید
- استخراج کد قابل استفاده مجدد
- قوانین نامگذاری را دنبال کنید
- اسامی را با قوانین آنها اصلاح کنید
زمینه
هنگام دست زدن به یک تک نام فایل یا مسیر مسیر، نام های مبهم مانند فایل یا dirName ایجاد سردرگمی
- الف فایل باید نمایانگر یک فایل باشد
- الف نام فایل باید نشان دهنده نام یک فایل باشد
- محتویات فایل باید محتوای یک فایل را نشان دهد
- الف فایل Handler باید نشانگر یک منبع خارجی باشد
- dirName باید باشد مسیر مسیر
پاک کردن اسامی مانند نام فایل برای اسامی و مسیر مسیر برای دایرکتوری ها نقش هر متغیر را به اشتراک می گذارند.
وقتی یک فایل متغیر را نام می برید، می تواند دیگران را در مورد هدف آن گیج کند. آیا یک شی فایل یا فقط نام فایل را ذخیره می کند؟
وقتی یک متغیر را نام می برید dirName به جای directoryName منجر به ابهام می شود.
نام متغیرهای واضح و توصیفی، خوانایی و قابلیت نگهداری کد را به ویژه در محیط های مشارکتی بهبود می بخشد.
کد نمونه
اشتباه است
function importBoardGameScores(file) {
if (file) {
const data = fs.readFileSync(file, 'utf-8');
// Process board game...