जावास्क्रिप्ट स्टाइल गाइड
अपने सभी जावास्क्रिप्ट प्रोजेक्ट्स के लिए हमेशा समान कोडिंग कन्वेंशन का उपयोग करें।
जावास्क्रिप्ट कोडिंग कन्वेंशन
प्रोग्रामिंग के लिए कोडिंग कन्वेंशन शैली दिशानिर्देश हैं । वे आम तौर पर कवर करते हैं:
- चर और कार्यों के लिए नामकरण और घोषणा नियम।
- सफेद स्थान, इंडेंटेशन और टिप्पणियों के उपयोग के नियम।
- प्रोग्रामिंग प्रथाओं और सिद्धांतों
कोडिंग कन्वेंशन सुरक्षित गुणवत्ता :
- कोड पठनीयता में सुधार करता है
- कोड रखरखाव को आसान बनाएं
कोडिंग सम्मेलनों को टीमों के पालन के लिए नियमों का दस्तावेजीकरण किया जा सकता है, या सिर्फ आपका व्यक्तिगत कोडिंग अभ्यास हो सकता है।
यह पृष्ठ W3Schools द्वारा उपयोग किए जाने वाले सामान्य JavaScript कोड सम्मेलनों का वर्णन करता है।
आपको अगला अध्याय "सर्वोत्तम अभ्यास" भी पढ़ना चाहिए, और सीखना चाहिए कि कोडिंग के नुकसान से कैसे बचा जाए।
चर नाम
W3schools में हम पहचानकर्ता नामों (चर और फ़ंक्शन) के लिए कैमलकेस का उपयोग करते हैं।
सभी नाम एक अक्षर से शुरू होते हैं ।
इस पृष्ठ के निचले भाग में, आपको नामकरण नियमों के बारे में विस्तृत चर्चा मिलेगी।
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);
ऑपरेटरों के आसपास रिक्त स्थान
हमेशा ऑपरेटरों ( = + - * / ), और अल्पविराम के बाद रिक्त स्थान रखें:
उदाहरण:
let x = y + z;
const myArray = ["Volvo", "Saab",
"Fiat"];
कोड इंडेंटेशन
कोड ब्लॉक के इंडेंटेशन के लिए हमेशा 2 रिक्त स्थान का उपयोग करें:
कार्य:
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 वर्णों से अधिक लंबी पंक्तियों से बचें।
यदि एक जावास्क्रिप्ट स्टेटमेंट एक लाइन पर फिट नहीं होता है, तो इसे तोड़ने का सबसे अच्छा स्थान ऑपरेटर या कॉमा के बाद होता है।
उदाहरण
document.getElementById("demo").innerHTML =
"Hello Dolly.";
नामकरण की परंपरा
अपने सभी कोड के लिए हमेशा समान नामकरण परंपरा का उपयोग करें। उदाहरण के लिए:
- कैमलकेस के रूप में लिखे गए चर और कार्य नाम
- UPPERCASE में लिखे गए वैश्विक चर (हम नहीं करते हैं, लेकिन यह काफी सामान्य है)
- अपरकेस में लिखा स्थिरांक (जैसे पीआई)
क्या आपको चर नामों में hyp-hens , camelCase , या under_scores का उपयोग करना चाहिए?
यह एक ऐसा प्रश्न है जिस पर प्रोग्रामर अक्सर चर्चा करते हैं। उत्तर इस बात पर निर्भर करता है कि आप किससे पूछते हैं:
HTML और CSS में हाइफ़न:
HTML5 विशेषताएँ डेटा से शुरू हो सकती हैं- (डेटा-मात्रा, डेटा-कीमत)।
CSS संपत्ति-नामों (फ़ॉन्ट-आकार) में हाइफ़न का उपयोग करता है।
हाइफ़न को घटाव प्रयासों के रूप में गलत किया जा सकता है। जावास्क्रिप्ट नामों में हाइफ़न की अनुमति नहीं है।
अंडरस्कोर:
कई प्रोग्रामर विशेष रूप से SQL डेटाबेस में अंडरस्कोर (date_of_birth) का उपयोग करना पसंद करते हैं।
PHP दस्तावेज़ीकरण में अक्सर अंडरस्कोर का उपयोग किया जाता है।
पास्कलकेस:
PascalCase को अक्सर C प्रोग्रामर्स द्वारा पसंद किया जाता है।
टेढ़े - मेढ़े लिखावट वाले बड़े संयुक्त शब्द:
कैमलकेस का उपयोग जावास्क्रिप्ट द्वारा, jQuery द्वारा, और अन्य जावास्क्रिप्ट पुस्तकालयों द्वारा किया जाता है।
$ चिह्न के साथ नाम प्रारंभ न करें। यह आपको कई जावास्क्रिप्ट लाइब्रेरी नामों के साथ संघर्ष में डाल देगा।
HTML में जावास्क्रिप्ट लोड हो रहा है
बाहरी स्क्रिप्ट लोड करने के लिए सरल सिंटैक्स का उपयोग करें (प्रकार विशेषता आवश्यक नहीं है):
<script src="myscript.js"></script>
HTML तत्वों तक पहुंचना
"अस्वच्छ" HTML शैलियों का उपयोग करने के परिणामस्वरूप, जावास्क्रिप्ट त्रुटियाँ हो सकती हैं।
ये दो जावास्क्रिप्ट स्टेटमेंट अलग-अलग परिणाम देंगे:
const obj = getElementById("Demo")
const obj = getElementById("demo")
यदि संभव हो, तो HTML में समान नामकरण परंपरा (JavaScript के रूप में) का उपयोग करें।
एचटीएमएल स्टाइल गाइड पर जाएं ।
फाइल एक्सटेंशन
HTML फ़ाइलों में एक .html एक्सटेंशन होना चाहिए ( .htm की अनुमति है)।
CSS फाइलों में .css एक्सटेंशन होना चाहिए।
JavaScript फ़ाइलों में .js एक्सटेंशन होना चाहिए।
लोअर केस फ़ाइल नामों का प्रयोग करें
अधिकांश वेब सर्वर (अपाचे, यूनिक्स) फ़ाइल नामों के मामले में संवेदनशील होते हैं:
london.jpg को London.jpg के रूप में एक्सेस नहीं किया जा सकता।
अन्य वेब सर्वर (Microsoft, IIS) केस संवेदी नहीं हैं:
london.jpg को London.jpg या london.jpg के रूप में एक्सेस किया जा सकता है।
यदि आप अपर और लोअर केस के मिश्रण का उपयोग करते हैं, तो आपको बेहद सुसंगत होना होगा।
यदि आप किसी असंवेदनशील केस से, केस-संवेदी सर्वर पर जाते हैं, तो छोटी-छोटी त्रुटियां भी आपकी वेब साइट को खराब कर सकती हैं।
इन समस्याओं से बचने के लिए, हमेशा लोअर केस फ़ाइल नामों (यदि संभव हो) का उपयोग करें।
प्रदर्शन
कंप्यूटर द्वारा कोडिंग कन्वेंशन का उपयोग नहीं किया जाता है। अधिकांश नियमों का कार्यक्रमों के निष्पादन पर बहुत कम प्रभाव पड़ता है।
छोटी लिपियों में इंडेंटेशन और अतिरिक्त रिक्त स्थान महत्वपूर्ण नहीं हैं।
विकास में कोड के लिए, पठनीयता को प्राथमिकता दी जानी चाहिए। बड़ी उत्पादन लिपियों को छोटा किया जाना चाहिए।