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