5. التعليقات وإمكانية القراءة

يُقرأ الكود في كثير من الأحيان أكثر مما يُكتب. تساعد التعليقات في شرح لماذا يقوم الكود بما يفعله.

1. التعليقات ذات السطر الواحد

استخدم شرطتين مائلتين للأمام (//).

javascript // This line declares a variable to hold the user's name (هذا السطر يعلن عن متغير لحفظ اسم المستخدم) let userName = 'Alice';

let age = 30; // Inline comments can explain tricky parts (يمكن للتعليقات المضمنة أن تشرح الأجزاء الصعبة)

2. التعليقات متعددة الأسطر

تُستخدم للشروحات الأطول، أو للتعليق مؤقتًا على كتل كبيرة من الكود. تبدأ بـ /* وتنتهي بـ */.

javascript /* This function calculates the total price, including tax and shipping costs. It needs three parameters: base price, tax rate, and a boolean flag for premium shipping. */ function calculateTotal(price, tax, premium) { // ... function logic }

أفضل الممارسات لإمكانية القراءة

1. أسماء ذات معنى (Meaningful Names): يجب أن تحدد المتغيرات والدوال بوضوح الغرض منها (على سبيل المثال، استخدم firstName بدلاً من fn).
2. تنسيق متناسق (Consistent Formatting): استخدم المسافات البادئة (Indentation) (عادةً 2 أو 4 مسافات) باستمرار.
3. تجنب التعليقات المفرطة: إذا كان الكود واضحًا، فإن التعليق يكون زائداً عن الحاجة.