10 اصطلاحات تسمية JavaScript أساسية يجب على كل مطور معرفتها

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

تعد المتغيرات والمنطقية والوظائف والثوابت والفئات والمكونات والطرق والوظائف الخاصة والمتغيرات العامة والملفات من بين عناصر JavaScript التي تتطلب اصطلاحات تسمية متسقة. يمكنك تحسين تنظيم الكود وفهمه من خلال تطبيق اصطلاحات التسمية الموحدة عبر كل هذه المكونات ، مما يوفر الوقت والجهد على المدى الطويل.

1. تسمية المتغيرات

في JavaScript ، يتم تخزين البيانات في متغيرات. من الضروري اختيار أسماء وصفية للمتغيرات التي تعكس وظيفتها بدقة. يمكنك ، على سبيل المثال ، بديلا اسم المستخدم أو السعر الكلي لاسم المتغير بدلاً من x.

طريقة جيدة لتسمية المتغيرات هي كما يلي:

يترك السعر الإجمالي = 100;
يترك اسم المستخدم = "جون";

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

2. تسمية منطقية

المتغيرات التي يمكن أن تحتوي على قيمتين فقط ، أي إما

حقيقي أو خطأ شنيع، والمعروفة باسم Boolean. من الضروري اختيار الأسماء المناسبة للمتغيرات المنطقية التي تعبر عن الغرض منها.

للتوضيح ، بدلاً من اختيار اسم متغير مثل صحيح، يجب أن تفضل الذهاب مع صالح أو hasValue.

ضع في اعتبارك هذا المثال:

يترك isValid = حقيقي;
يترك hasValue = خطأ شنيع;

في هذا المثال ، توضح أسماء المتغيرات المنطقية الوصفية ما تمثله.

3. وظائف التسمية

تشير الوظيفة في JavaScript إلى وحدة تعليمات برمجية قائمة بذاتها تهدف إلى أداء مهمة معينة. إنها كتلة من الكود يمكن استدعاؤها أو استدعاؤها بواسطة أجزاء أخرى من الكود وتعمل ككيان مستقل.

لتسمية الوظائف بشكل فعال ، استخدم الأسماء الوصفية التي تنقل الغرض منها. على سبيل المثال ، بدلاً من خلق وظيفةفو، اختر المزيد من الأسماء التوضيحية مثل ValidateUserInput أو حساب السعر الإجمالي.

على سبيل المثال:

وظيفةحساب السعر الإجمالي(كمية السعر) {
يعود كمية السعر؛
}
وظيفةValidateUserInput(مدخل) {
يعود الإدخال! == غير معرف && الإدخال! == باطل;
}

4. تسمية الثوابت

الثوابت هي متغيرات لا يمكن إعادة تعيينها. عند تسمية الثوابت ، من المهم استخدام كل الأحرف الكبيرة والشرطات السفلية لفصل الكلمات.

على سبيل المثال:

مقدار ثابت MAX_PRICE = 1000;
مقدار ثابت MIN_PRICE = 0;

في هذا المثال ، تم استخدام جميع الأحرف الكبيرة والشرطات السفلية لفصل الكلمات في الأسماء الثابتة.

5. فئات التسمية

في JavaScript ، يمكن إنشاء الكائنات باستخدام مخططات تسمى الفئات. لتحقيق ممارسات تسمية نقية ، من الأهمية بمكان تنفيذ PascalCase ، وهو اصطلاح تسمية يتطلب استخدام الأحرف الكبيرة للحرف الأول من كل كلمة.

خذ على سبيل المثال:

فصلعربة التسوق{
البناء(يصنع نموذجا) {
هذا.make = صنع ؛
هذا.model = نموذج ؛
 }
}

في هذا المثال ، الفصل عربة التسوق تم تسميته باستخدام PascalCase ، مما يعني أن الحرف الأول من كل كلمة في اسم الفئة تمت كتابته بأحرف كبيرة ، ولا توجد مسافات أو شرطات سفلية بين الكلمات.

6. مكونات التسمية

المكونات هي اللبنات الأساسية في تطوير البرمجيات الحديثة ، لا سيما في أطر مثل React، والتي تؤكد على الكود القابل لإعادة الاستخدام.

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

مرة أخرى ، نوصي بشدة باستخدام اصطلاح تسمية PascalCase لتسمية المكونات. هذا يعني كتابة الحرف الأول من كل كلمة في اسم المكون بحرف كبير.

تساعدك هذه الاتفاقية في تمييز المكونات عن مقاطع التعليمات البرمجية الأخرى ، وتبسيط التعريف والمعالجة.

وظيفةزر(الدعائم) {
يعود<زر>{props.label}زر>;
}

في هذا المثال ، تم استخدام اصطلاح تسمية PascalCase لتسمية المكون زر.

7. طرق التسمية

عند تسمية الطرق ، من الضروري استخدام الأسماء الوصفية التي تنقل بنجاح ما تنجزه الطريقة لأن الأساليب هي وظائف تتعلق بالكائن.

على سبيل المثال:

فصلسيارة{
البناء(يصنع نموذجا) {
هذا.make = صنع ؛
هذا.model = نموذج ؛
 }
 بدء تشغيل المحرك() {
// كود لبدء المحرك 
 } 
 أوقف المحرك() { 
// كود لإيقاف المحرك 
 }
 }
}

الأسماء الوصفية (بدء تشغيل المحرك, أوقف المحرك) للطرق الواردة في هذا المثال ، مما يضمن سهولة فهم الغرض المقصود منها.

8. تسمية الوظائف الخاصة

الوظائف التي تم تعريفها على أنها خاصة تقتصر على الوصول إليها فقط داخل الكائن حيث تم تعريفها. من الضروري إضافة شرطة سفلية (_) للإشارة إلى أن الوظائف خاصة.

هذا مثال:

فصلسيارة{
البناء(يصنع نموذجا) {
هذا.make = صنع ؛
هذا.model = نموذج ؛
 }
 _بدء تشغيل المحرك() {
// كود لبدء المحرك
 }
 _أوقف المحرك() {
// كود لإيقاف المحرك
 }
}

باستخدام شرطة سفلية بادئة في هذا المثال ، يُشار إلى أن الوظائف خاصة.

9. تسمية المتغيرات العالمية

يمكن الوصول إلى المتغيرات التي تم تصنيفها على أنها عالمية من أي جزء من قاعدة التعليمات البرمجية. أثناء تسمية مثل هذه المتغيرات العالمية ، من الضروري استخدام أسماء واضحة ووصفية تنقل الغرض المقصود منها بشكل فعال.

على سبيل المثال:

مقدار ثابت MAX_PRICE = 1000;
مقدار ثابت MIN_PRICE = 0;
وظيفةسعر الاختيار(سعر) {
لو (السعر> MAX_PRICE) {
// كود للتعامل مع الأسعار المرتفعة
 } آخرلو (السعر // كود للتعامل مع الأسعار المنخفضة
 }
}

10. تسمية الملفات

يعتبر تنظيم الملفات الفعال جانبًا حاسمًا في إدارة مشروع JavaScript بنجاح. لضمان اصطلاحات تسمية مبسطة ومتسقة ، من الضروري فصل الكلمات في أسماء الملفات باستخدام الأحرف الصغيرة والواصلات.

يُفضل استخدام الأحرف الصغيرة لأن JavaScript هي لغة حساسة لحالة الأحرف ، مما يعني أن اللغة تتعامل مع الأحرف الصغيرة والكبيرة بشكل مختلف. يضمن استخدام الأحرف الصغيرة لأسماء الملفات الاتساق وتجنب الالتباس عند الرجوع إلى الملفات في التعليمات البرمجية.

تُستخدم الواصلات لفصل الكلمات في أسماء الملفات لأن المسافات غير مسموح بها في أسماء الملفات. يمكن أيضًا استخدام بدائل أخرى مثل الشرطات السفلية أو حالة الجمل ، ولكن تُفضل الواصلات عمومًا لسهولة قراءتها.

يؤدي استخدام الواصلات أيضًا إلى تسهيل الوصول إلى أسماء الملفات للمستخدمين الذين يستخدمون برامج قراءة الشاشة أو التقنيات المساعدة الأخرى.

تطبيقي/
├── src /
 ├── مكونات /
 ├── button.js
 ├── حقل الإدخال
├── الأواني /
 ├── string-utils.js
 ├── date-utils.js
├── app.js
├── index.js

في هذا المثال ، يتم استخدام الأحرف الصغيرة والواصلات لفصل الكلمات في أسماء الملفات.

أهمية اتباع اصطلاحات التسمية في JavaScript

يعد اتباع اصطلاحات التسمية الجيدة جانبًا أساسيًا لكتابة تعليمات برمجية نظيفة وقابلة للصيانة في JavaScript. باتباع هذه الاصطلاحات ، يمكنك جعل التعليمات البرمجية الخاصة بك أكثر قابلية للقراءة والصيانة ، خاصة في بعضها أطر عمل JavaScript حيث يُطلب منك التعامل مع التعليمات البرمجية الضخمة ، والتي يمكن أن توفر لك الوقت والجهد في المدى الطويل.