اتفاقيات التسمية هي مجموعة من القواعد والمبادئ التوجيهية التي يتم استخدامها لإنشاء أسماء متسقة وواضحة لمتغيرات، ودوال، وفئات الكود. وفيما يلي بعض أهم اتفاقيات التسمية التي يجب اتباعها:
- استخدم أسماء ذات معنى: يجب أن تعكس أسماء المتغيرات والوظائف والدورات الغرض منها بوضوح.
- استخدم الكلمات الإنجليزية: يُفضل استخدام الكلمات الإنجليزية في أسماء المتغيرات والوظائف والدورات، حيث أنها شائعة الاستخدام ويمكن التعرف عليها بسهولة.
- استخدم أسماء صغيرة: يجب أن تكون أسماء المتغيرات والوظائف والدورات صغيرة الحجم وسهلة النطق.
- تجنب الأسماء المختصرة: قد تكون الأسماء المختصرة صعبة القراءة والفهم، لذا تجنب استخدامها قدر الإمكان.
- استخدم أحرف الكتابة الكبيرة في بداية أسماء الفئات: في جافا سكريبت، تُكتب أسماء الفئات بحرف كبير في البداية.
- استخدم أسلوب الكتابة بالسنام (camelCase): في أسلوب الكتابة بالسنام، تبدأ الكلمات في اسم المتغير بحرف صغير، ويتم كتابة الكلمات اللاحقة بحرف كبير. على سبيل المثال، المتغير الذي يخزن اسم المستخدم يمكن تسميته بـ "userName".
- استخدم أسلوب كتابة باسكال (PascalCase): في أسلوب كتابة باسكال، تبدأ جميع الكلمات في اسم المتغير بحرف كبير. على سبيل المثال، يمكن تسمية المتغير الذي يخزن اسم المستخدم بـ "UserName".
مثال جافا سكريبت:
// متغير يحتوي على اسم المستخدم
let userName = "John Doe";
// دالة تحيي المستخدم
function sayHello(userName) {
console.log("Hello, " + userName);
}
// فئة تمثل المستخدم
class User {
constructor(name) {
this.name = name;
}
sayHello() {
console.log("Hello, " + this.name);
}
}
في هذا المثال، تم استخدام أسماء ذات معنى وواضحة لجميع المتغيرات والوظائف والدورات. كما تم استخدام اتفاقيات التسمية الصحيحة، مما يجعل الكود سهل القراءة والفهم.