هميشه از قوانين كدنويسي يكسان براي همه پروژه هاي جاوااسكريپت خود استفاده كنيد.
قراردادهاي كدنويسي ، دستورالعمل هاي روش يا سبك براي برنامه نويسي هستند .عدم رعايت اكثر آنها باعث هيج خطاي نحوي(Syntax Error) نمي شود، آنها قالبهاي تنظيم كد هاي برنامه ميباشند .اين قراردادها موارد زيررا پوشش ميدهند.
رعايت اين قوانين مزيت هائي جهت كيفيت ايمني برنام ايجاد ميكنند:
اين قوانين كد نويسي ميتواند براي تيم ها قوانين مستندشده اي باشد، كه آنرا رعايت نمايند، يا فقط تمرين فردي شما باشد.
در اين صفحه قوانين سبك كدنويسي كه درW3School مورد استفاده است بيان ميگردد .
در فصل بعدي ميتوانيد بهترين شيوه ها را مطالعه كنيد، و ياد بگيريد چگونه از مشكات كدنويسي اجتناب كنيد.
درW3School براي شناسه متغير ها وتوابع از قانون camelCase استفاده ميشود .همه آن ها با يك حرف شروع ميشوند .اگر آنها از تركيب چند كلمه تشكيل ميشوند، اولين كلمه حروف كوچك وحرف اول كلمات بعدي حروف بزرگ ومابقي كوچك(camelCase rules) .
در پائين صفحه بحث گسترده تري در مورد قوانين نام گذاري آمده است.
firstName = "John"; lastName = "Doe"; price = 19.90; tax = 0.20; fullPrice = price + (price * tax);
هميشه اطراف عملگرها(= + - * /) و بعداز كاما فاصله بگذاريد .
مثالها
let x = y + z; const myArray = ["Volvo", "Saab", "Fiat"];
هميشه براي فرورفتگي كد بلوك ها از دو بلنك استفاده كنيد.
مثال ـ Functions:
function toCelsius(fahrenheit) { return (5 / 9) * (fahrenheit - 32); }
براي فرورفتگي از(tabulators) Tabs استفاده نمائيد . اديتور هاي مختلف آنهارا بفرم مختلف تفسير ميكنند.
قوانين كلي براي تك دستوري ، هميشه دستور ساده با سميكالن ختم شود.
مثالها
const cars = ["Volvo", "Saab", "Fiat"];
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
قوانين كلي براي دستورات پيچيده يا تركيبي:
مثال ـ Function :
function toCelsius(fahrenheit) { return (5 / 9) * (fahrenheit - 32); }
مثال ـ Loops:
for (let i = 0; i < 5; i++) {
x += i;
}
مثال ـ Condtions:
f (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}
قوانين كلي براي تعاريف شئ:
مثال ـ شئ
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
شئ هاي كوتاه ميتوانند در يك خط نوشته شوند .بين ويژگي ها بلنك قرار دهيد.
onst person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};
براي قابليت خواندن دستورات ازنوشتن خطوط بيش80 اجتناب كنيد .
اگر دستور در يك خط تنظيم نشود، بهترين مكان براي شكست خط بعد از عملگريا كامااست.
مثال ـ شكست خط بعداز =
document.getElementById("demo").innerHTML =
"Hello Dolly.";
هميشه از قوانين مشابه براي نام گذاري كد هاي خود استفاده نمائيد، مانند:
آيا بايد ازhyp-hens , camelCase و under_scores استفاده كرد .اين سوالي است كه همه برنامه دارند، پاسخ بستگي به افراد دارد.
درHTML5 ويژگي ها با data- (data-quantity , data-price) ميتوانند شروع شوند .
درCSS خط تيره درproperty-names مثل(font-size)استفاده ميشوند .
خط تيره ممكن است به عنوان تلاش براي تفريق اشتباه بررسي شود .خط تيره در نام گذاري جاوااسكريپت مجاز نيست.
بيشتر برنامه نويسان زير خط را دربرنامه ترجيح ميدهند .مثل(dae_of_birth)مخصوصا در بانك هاي اطلاعاتي اسكيوال
زير خط ها در اسنادPHP اغلب مورد استفاده قرار ميگيرد .
اين حالت را بيشتر برنامه نويسان زبان برنامه پاسكال ترجيح ميدهند .در اين فرم اول نام كلمات
در نامگذاري باحروف بزرگ مثل
اين قانون در خود جاوااسكريت رعايت شده است .اولين كلمه نام حروف كوچك وحرف اول كلمات بعدي حروف بزرگ . مثال(lastName , totalValue)
حرف اول نام با كراكتر دلار$ شروع نشود .اگر رعايت نكنيد با نامهاي كتابخانه اي جاوااسكريپت تداخل پيدا مي كند.
براي بارگذازي فايل خارجي جاوااسكريپت فرم ساده زير ميباشد .در اين فرم ويژگيtype ضروري نيست
<script src="myscript.js"></script >
استفاده نامنظم ازHTML Styles در دسترسي به عناصرHTML ممكن است منجر خطاي جاواسكريپتي شود .بعنوان نمونه دو دستور زير دو نتيجه متفاوت ايجاد ميكنند.
const obj = getElementById("Demo");
const obj = getElementById("demo");
اگر ممكن است از همان قواعد نامگذاري جاوااسكريپت درHTML استفاده كنيد .
بيشتر سرور هاي وبي(Apache, Unix) نسبت به حروف حساس هستند . مثلا فايلي با نامlondon.jpg را نميتوان با نام London.jpg دسترسي داشت.
بعضي از سرورهاي وبي(Microsoft ,lls) نسبت به حروف حساسيت ندارند . مثلا فايل london.jpgرا ميتوان باLondon.jpg دسترسي داشت .
اگر شما بين وب سرورهاي حساس به حروف وغير حساس رفت وبرگشت داريد، ممكن سايت شما حتي در گيرخطاي كوچك هم متوقف گردد.
براي اجتناب از اين مشكلات، هميشه نام فايلهاي با حروف كوچك استفاده كنيد.
قوانين كد نويسي مورد استفاده كامپيوتر نيست .اكثر قوانين تاثيركمي در اجرا دارند.
تورفتگي وفضاي اضافي خالي در اسكريپت هاي كوچك قابل توجه نيستند.
قوانين براي كد هاي قابل توسعه وافزايش قابليت خواندن، بايد ترجيح داده شود .اسكريپت هاي بزرگتر بايد حداقل شوند.