जेसक्रिप्ट स्टाइल गाइड

अपने सभी जेसक्रिप्ट प्रोजेक्ट के लिए हमेशा एक समान कोड कंवेंशन का उपयोग करें।

जेसक्रिप्ट कोड कंवेंशन

कोड कंवेंशन (Coding conventions) का अर्थ हैप्रोग्रामिंग के शैली दिशानिर्देशये सिद्धांत कुछ सारणीबद्ध नियमों में शामिल हैं:

  • वेरियेबल और फ़ंक्शन के नामकरण और घोषणा नियम
  • खाली जगह, इन्डेंटेशन और टिप्पणी के नियम
  • प्रोग्रामिंग आदत और नियम

कोड कंवेंशनगुणवत्ता सुनिश्चित करें：

  • कोड पठनीयता बेहतर करें
  • कोड देखभाली बढ़ाएं

कोड कंवेंशन टीम द्वारा अनुसरित लिखित नियम हो सकते हैं या आपके निजी कोडिंग आदतें हो सकती हैं।

इस पृष्ठ पर CodeW3C.com द्वारा उपयोग किए जाने वाले सामान्य जेसक्रिप्ट कोड समझाया गया है।

आपको अगला अध्याय 'श्रेष्ठ प्रथाएँ' जारी रखना चाहिए, जिसमें आपको कोडिंग फैंटाम से बचने के तरीके सीखने हैं।

वेरियेबल नाम

CodeW3C.com पर, हमने पहले की नाम (वेरियेबल्स और फ़ंक्शन) के लिएकूदालीय वर्ग में आदि हैं।

सभी नामअक्षरशुरुआत।

इस पृष्ठ के नीचे, हम नामकरण नियमों की व्यापक चर्चा करेंगे。

firstName = "Bill";
lastName = "Gates";
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);
}

गोठिलाकरण (indentation) के लिए टैब का उपयोग न करें। विभिन्न संपादकों को टैब के व्याख्यान भिन्न हैं।

वाक्य नियम

सरल वाक्य के लिए सामान्य नियम:

हमेशा एक ही वाक्य को सेकंड को बंद करें:

उदाहरण

var values = ["Volvo", "Saab",  "Fiat"];
var person = {
    firstName: "Bill",
     lastName: "Gates",
    age: 50,
    eyeColor:  "blue"
};

जटिल वाक्य (compound) के लिए सामान्य नियम:

  • पहली पंक्ति के अंत में खुलने वाले बारह्न लिखें
  • खुलने वाले बारह्न के पहले एक खाली जगह उपयोग करें
  • बंद बारह्नहें से पहले नई पंक्ति लिखें, बिना पहले खाली जगह के
  • जटिल वाक्य को सेकंड को नहीं बंद करें

तत्व:

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: "Bill",
    lastName: "Gates",
    age: 19,
    eyeColor:  "blue"
};

छोटे ऑब्जैक्ट को एक पंक्ति में कम्प्रेस किया जा सकता है, केवल गुणों के बीच में खाली जगह का उपयोग करते हुए:

var person = {firstName:"Bill", lastName:"Gates", age:50, eyeColor:"blue"};

लाइन लंबाई कम से कम 80

पठनीयता को बढ़ाने के लिए, प्रत्येक लाइन की लंबाई 80 अक्षर से अधिक नहीं होनी चाहिए。

यदि JavaScript बयान एक लाइन से अधिक लंबा होता है, तो अच्छा होगा कि उसे ऑपरेटर या कमा बयान के बाद से लाइन बदलने के लिए।

उदाहरण

document.getElementById("demo").innerHTML =
    "Hello Kitty.";

खुद से प्रयास करें

नामकरण संधि

कृपया आपके सभी कोड के लिए एक ही नामकरण संधि का उपयोग करें। उदाहरण के लिए:

  • वेरियेबल और फ़ंक्शन नाम कोकुर्सी-वर्ग बड़े-छोटे (camelCase)लिखने के लिए
  • सार्वभौमिक वेरियेबल कोबड़े अक्षर（हम ऐसा नहीं करते हैं, लेकिन यह काफी सामान्य है）
  • स्थायी (जैसे PI) कोबड़े अक्षर

क्या हमें वेरियेबल नामों में उपयोग करना चाहिएहाइफेन्स、कुर्सी-वर्ग बड़े-छोटे (camelCase)याअंडरस्कोरक्या?

यह प्रोग्रामरों को अक्सर चर्चा की जाने वाली समस्या है। जवाब इस प्रश्न को कौन दे रहा है इस पर निर्भर करता है:

HTML और CSS में हाइफेन्स:

HTML5 विशेषताएं data- से शुरू हो सकती हैं (data-quantity, data-price).

CSS में property-names में हाइफेन्स (font-size) का उपयोग किया जाता है。

हाइफेन्स को गलती से कमी गणना संकेतक के रूप में देखा जा सकता है।JavaScript नामकरण में हाइफेन्स का उपयोग नहीं किया जाना चाहिए。

अंडरस्कोर:

अनेक प्रोग्रामर अंडरस्कोर (date_of_birth) का उपयोग करना पसंद करते हैं, विशेष रूप से SQL डाटाबेस में。

अंडरस्कोर अक्सर PHP संदर्भ में उपयोग किया जाता है。

पास्कल नामकरण पद्धति (PascalCase):

C भाषा के प्रोग्रामर अक्सर पास्कल नामकरण पद्धति का उपयोग करते हैं。

कुर्सी-वर्ग बड़े-छोटे (camelCase):

JavaScript खुद, jQuery और अन्य JavaScript लाइब्रेरियां कुर्सी-वर्ग बड़े-छोटे (camelCase) में उपयोग करती हैं。

JavaScript नाम $ संकेतक से नहीं शुरू होने चाहिए। इससे JavaScript नाम टकराव हो सकता है。

HTML में JavaScript को लोड करना

बाहरी स्क्रिप्ट को लोड करने के लिए सरल व्याकरण (type विशेषता आवश्यक नहीं है):

<script src="myscript.js"></script>

HTML एलीमेंट को पहुंचना

"असाफ-सफाई करने वाले" HTML शैली के परिणाम, शायद JavaScript गलती का कारण बन सकते हैं.

ये दो JavaScript बयान अलग-अलग परिणाम देते हैं:

var obj = getElementById("Demo")
var obj = getElementById("demo")

यदि संभव हो, HTML में एक ही नामकरण संधि का उपयोग करें (जैसा कि JavaScript के तरह).

HTML स्टाइल गाइड को देखें।

फ़ाइल एक्सटेंशन

HTML फ़ाइलों को .html एक्सटेंशन (बजाय .htm)

CSS फ़ाइलों को .css एक्सटेंशन

JavaScript फ़ाइलों को .js एक्सटेंशन

छोटे फ़ाइल नाम का उपयोग करें

अधिकांश वेब सर्वर (Apache, Unix) फ़ाइल नाम के आकार के लिए संवेदनशील हैं:

london.jpg London.jpg के रूप में पहुँचा नहीं जा सकता है。

अन्य वेब सर्वर (माइक्रोसॉफ्ट IIS) आकार के लिए असंवेदनशील हैं:

london.jpg London.jpg या london.jpg के रूप में पहुँचा सकता है。

यदि आप आकार के आकार का उपयोग करते हैं, तो आपको निरंतर और समान रूप से इसे बनाए रखना चाहिए。

अगर आप अगले से बड़े साइज़ के सेवाप्रदाता से बड़े साइज़ के सेवाप्रदाता पर जाएंगे, तो यह छोटे गलतियां भी आपके वेबसाइट को नष्ट कर सकती हैं。

इन समस्याओं को बचाने के लिए, हमेशा छोटे फ़ाइल नाम (यदि संभव हो) का उपयोग करें。

प्रदर्शन

कंप्यूटर नहीं कोड कन्वेंशन का इस्तेमाल करते हैं।अधिकांश नियमों पर कार्यक्रम के कार्यान्वयन पर छोटा असर पड़ता है。

छोटे स्क्रिप्ट के लिए इंडेंटेशन और अतिरिक्त स्पेस को अहम नहीं माना जाता है。

डेवलपमेंट में चल रहे स्क्रिप्ट के लिए, पढ़ाई की उपलब्धता को प्राथमिकता देनी चाहिए।बड़े पैमाने के उत्पादन स्क्रिप्ट को छोटा करना चाहिए。