إزاي تختار اسم واضح للمتغير والدالة

الاسم الواضح بيقلل المجهود المطلوب لفهم الكود لما ترجعله بعد فترة أو زميلك يشتغل عليه الهدف مش أطول اسم ممكن الهدف إن الاسم يوضح معنى القيمة أو وظيفة الدالة في مكان استخدامها

سم القيمة حسب معناها

متغير اسمه data ممكن يكون مقبول في مثال صغير لكن جوه شاشة فيها منتجات وطلبات ومستخدمين الاسم ده مش بيقول كتير اختار اسم يحدد المحتوى

const x = 3;
const y = 120;
const z = x * y;
console.log(z);

const quantity = 3;
const unitPrice = 120;
const subtotal = quantity * unitPrice;
console.log(subtotal);

نفس العملية بقت مفهومة من غير تعليق يترجم كل حرف الاسم الجيد بيشرح ليه القيمة موجودة مش بس نوعها

وضح وحدة القياس

ال timeout ممكن يكون بالثواني أو بالمللي ثانية لو الوحدة مش ظاهرة في نوع البيانات ضيفها للاسم ده يقلل أخطاء إرسال رقم صحيح بوحدة غلط

const delaySeconds = 5;
const delayMs = delaySeconds * 1000;
console.log(delayMs);

اسم الدالة يوضح هي بتعمل إيه

اسم زي calculateSubtotal يوحي بحساب قيمة واسم زي sendReceipt يوحي بإجراء إرسال متسميش دالة getTotal وهي بتعدل الطلب وتبعت بريد من غير ما يكون ده واضح

التسمية مش بديل عن تصميم الدالة لو محتاج جملة طويلة علشان تشرح كل اللي بتعمله فده ممكن يكون مؤشر إنها شايلة مهام كتير

function calculateSubtotal(unitPrice, quantity) {
  return unitPrice * quantity;
}

console.log(calculateSubtotal(120, 3));

القيم المنطقية تتقري كسؤال واضح

أسماء زي isPublished و hasImage و canEdit بتساعد الشرط يتقري بشكل طبيعي تجنب النفي المركب اللي يجبرك تفك المعنى في دماغك كل مرة

const isPublished = true;
const hasImage = false;
const canShowCard = isPublished && hasImage;
console.log(canShowCard);

false

مفرد ولا جمع

لو المتغير بيحمل عنصر واحد سمه product ولو قائمة سمه products ده مش قانون في اللغة لكنه أسلوب مفيد يوضح توقعك من القيمة من غير فتح تعريفها

بلاش اختصارات مش مفهومة

الاختصارات المعروفة في المجال زي url ممكن تكون أوضح من الاسم الطويل لكن اختصار أنت اخترعته علشان توفر خمس حروف هيكلف القارئ وقت اسم قصير داخل حلقة صغيرة يختلف عن اسم متغير مستخدم في ملف كبير

اتبع أسلوب المشروع

لو الفريق بيستخدم camelCase للمتغيرات التزم بيه ولو اللغة والمشروع بيستخدموا snake_case اتبع نفس النمط الاتساق بيسهل البحث والتعديل أكتر من فرض تفضيل شخصي على كل ملف

وقت إعادة التسمية استخدم أداة بتفهم المراجع وراجع الاختبارات خصوصا لو الاسم جزء من API أو بيانات محفوظة لأن تغيير الاسم الخارجي ممكن يكسر مستخدمين للكود

تدريب بسيط

اختار دالة قديمة فيها أسماء زي temp و data و result واكتب جنب كل قيمة معناها وبعدها غير الأسماء اللي محتاجة توضيح فقط لو الاسم الحالي واضح في سياقه متطولوش لمجرد التغيير