دليل نمط جافا سكريبت
استخدم دائمًا نفس اصطلاحات الترميز لجميع مشاريع JavaScript الخاصة بك.
اصطلاحات ترميز جافا سكريبت
اصطلاحات التشفير هي إرشادات نمطية للبرمجة . عادة ما يغطون:
- قواعد التسمية والإعلان عن المتغيرات والوظائف.
- قواعد استخدام المسافة البادئة والمسافة البادئة والتعليقات.
- ممارسات ومبادئ البرمجة
اتفاقيات التشفير تضمن الجودة :
- يحسن قراءة الكود
- اجعل صيانة الكود أسهل
يمكن أن تكون اصطلاحات الترميز قواعد موثقة للفرق لاتباعها ، أو تكون مجرد ممارسة ترميز فردية.
تصف هذه الصفحة اصطلاحات تعليمات JavaScript البرمجية العامة التي تستخدمها W3Schools.
يجب عليك أيضًا قراءة الفصل التالي "أفضل الممارسات" ، وتعلم كيفية تجنب مخاطر الترميز.
أسماء المتغيرات
في W3schools نستخدم camelCase لأسماء المعرفات (المتغيرات والوظائف).
كل الأسماء تبدأ بحرف .
في الجزء السفلي من هذه الصفحة ، ستجد مناقشة أوسع حول قواعد التسمية.
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);
مساحات حول العملاء
ضع دائمًا مسافات حول عوامل التشغيل (= + - * /) ، وبعد الفواصل:
أمثلة:
let x = y + z;
const myArray = ["Volvo", "Saab",
"Fiat"];
المسافة البادئة للكود
استخدم دائمًا مسافتين للمسافات البادئة لكتل التعليمات البرمجية:
المهام:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
لا تستخدم علامات التبويب (الجدولة) للمسافة البادئة. يفسر المحررون المختلفون علامات التبويب بشكل مختلف.
قواعد البيان
القواعد العامة للبيانات البسيطة:
- قم دائمًا بإنهاء جملة بسيطة بفاصلة منقوطة.
أمثلة:
const cars = ["Volvo", "Saab",
"Fiat"];
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};
القواعد العامة للبيانات المعقدة (المركبة):
- ضع قوس الفتح في نهاية السطر الأول.
- استخدم مسافة واحدة قبل قوس الفتح.
- ضع قوس الإغلاق على سطر جديد ، بدون مسافات بادئة.
- لا تنهي جملة معقدة بفاصلة منقوطة.
المهام:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
الحلقات:
for (let i = 0; i < 5; i++) {
x += i;
}
الشرطية:
if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}
قواعد الكائن
القواعد العامة لتعريفات الكائن:
- ضع قوس الفتح على نفس السطر مثل اسم الكائن.
- استخدم النقطتين بالإضافة إلى مسافة واحدة بين كل خاصية وقيمتها.
- استخدم علامات الاقتباس حول قيم السلسلة ، وليس حول القيم الرقمية.
- لا تضف فاصلة بعد آخر زوج من الخصائص والقيمة.
- ضع قوس الإغلاق على سطر جديد ، بدون مسافات بادئة.
- قم دائمًا بإنهاء تعريف كائن بفاصلة منقوطة.
مثال
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};
يمكن كتابة العناصر القصيرة بشكل مضغوط ، على سطر واحد ، باستخدام المسافات بين الخصائص فقط ، مثل هذا:
const person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};
طول الخط <80
لسهولة القراءة ، تجنب الأسطر التي يزيد طولها عن 80 حرفًا.
إذا كانت جملة JavaScript لا تتلاءم مع سطر واحد ، فإن أفضل مكان لكسرها هو بعد عامل تشغيل أو فاصلة.
مثال
document.getElementById("demo").innerHTML =
"Hello Dolly.";
اصطلاحات التسمية
استخدم دائمًا نفس اصطلاح التسمية لجميع التعليمات البرمجية الخاصة بك. فمثلا:
- أسماء المتغيرات والوظائف مكتوبة باسم camelCase
- المتغيرات العالمية مكتوبة بأحرف كبيرة (نحن لا نفعل ذلك ، لكنها شائعة جدًا)
- الثوابت (مثل PI) مكتوبة بحروف كبيرة
هل يجب استخدام الدواجن أو الجمل أو الدرجات السفلية في أسماء المتغيرات؟
هذا سؤال كثيرا ما يناقشه المبرمجون. الجواب يعتمد على من تسأل:
الواصلات في HTML و CSS:
يمكن أن تبدأ سمات HTML5 ببيانات- (كمية البيانات ، سعر البيانات).
يستخدم CSS واصلات في أسماء الخصائص (حجم الخط).
يمكن اعتبار الواصلات محاولات طرح بشكل خاطئ. غير مسموح باستخدام الواصلات في أسماء JavaScript.
يؤكد:
يفضل العديد من المبرمجين استخدام الشرطة السفلية (تاريخ الميلاد) ، خاصة في قواعد بيانات SQL.
غالبًا ما يتم استخدام الخطوط السفلية في توثيق PHP.
حالة باسكال:
غالبًا ما يفضل مبرمجي لغة PascalCase.
حالة الجمل:
يتم استخدام camelCase بواسطة JavaScript نفسها ، بواسطة jQuery ، ومكتبات JavaScript الأخرى.
لا تبدأ الأسماء بعلامة $. سوف يضعك في صراع مع العديد من أسماء مكتبات JavaScript.
تحميل JavaScript بتنسيق HTML
استخدم بناء جملة بسيطًا لتحميل البرامج النصية الخارجية (سمة النوع ليست ضرورية):
<script src="myscript.js"></script>
الوصول إلى عناصر HTML
قد ينتج عن استخدام أنماط HTML "غير مرتبة" أخطاء JavaScript.
ستنتج عبارتا JavaScript هاتان نتائج مختلفة:
const obj = getElementById("Demo")
const obj = getElementById("demo")
إذا أمكن ، استخدم نفس اصطلاح التسمية (مثل JavaScript) في HTML.
ملحقات الملفات
يجب أن يكون لملفات HTML امتداد .html ( مسموح به .htm ).
يجب أن يكون لملفات CSS امتداد .css .
يجب أن يكون لملفات جافا سكريبت الامتداد .js .
استخدم أسماء الملفات الصغيرة
معظم خوادم الويب (Apache و Unix) حساسة لحالة الأحرف فيما يتعلق بأسماء الملفات:
لا يمكن الوصول إلى london.jpg كـ London.jpg.
خوادم الويب الأخرى (Microsoft ، IIS) ليست حساسة لحالة الأحرف:
يمكن الوصول إلى london.jpg كـ London.jpg أو london.jpg.
إذا كنت تستخدم مزيجًا من الأحرف الكبيرة والصغيرة ، فيجب أن تكون متسقًا للغاية.
إذا انتقلت من خادم غير حساس لحالة الأحرف إلى خادم حساس لحالة الأحرف ، فقد تؤدي حتى الأخطاء الصغيرة إلى تعطل موقع الويب الخاص بك.
لتجنب هذه المشاكل ، استخدم دائمًا أسماء الملفات الصغيرة (إن أمكن).
أداء
لا تستخدم أجهزة الكمبيوتر اصطلاحات الترميز. معظم القواعد لها تأثير ضئيل على تنفيذ البرامج.
المسافة البادئة والمسافات الزائدة ليست مهمة في النصوص الصغيرة.
بالنسبة للكود قيد التطوير ، يجب تفضيل سهولة القراءة. يجب تصغير نصوص الإنتاج الأكبر حجمًا.