मैंने हाल ही में हमारे जावास्क्रिप्ट कोड को दस्तावेज करने के लिए jsdoc टिप्पणियों का उपयोग करना शुरू कर दिया है, हालांकि मुझे @param टैग के उपयोग के विरोधाभासी उदाहरण मिल रहे हैं।जेएसडॉक टिप्पणियों के लिए उपयोग करने के लिए सही आवरण क्या है?
देखें https://code.google.com/p/jsdoc-toolkit/wiki/TagParam (PascalCase)
और https://developers.google.com/closure/compiler/docs/js-for-compiler (ऊंट/लोअरकेस)।
var foo = 1;
console.log(typeof foo); // outputs "number"
केस सही jsDoc @param टिप्पणी के लिए उपयोग करने के लिए क्या है:
CamelCase के बाद से मेरे लिए समझ में आता है? या यह कोई महत्त्व नहीं रखता? मैं दस्तावेज़ निर्माण के लिए इसका उपयोग करने की योजना बना रहा हूं और टाइपिंग जांचने के लिए Google क्लोजर के माध्यम से कोड चला रहा हूं।
धन्यवाद! String
, Number
, और Boolean
:
ज्यादातर मामलों में, आप ऑब्जेक्ट प्रकार के बजाय आदिम प्रकार चाहते हैं। आवश्यक होने पर संकलक स्वचालित रूप से आदिम प्रकार को बॉक्स (प्रचार) करेगा, लेकिन विपरीत नहीं है। –
धन्यवाद cpeisert! मुझे निश्चित रूप से वह किताब मिलनी होगी! – magritte
निश्चित रूप से करते हैं। यह सिर्फ एक बंद पढ़ने की जानकारी के लिए, एक महान पढ़ा है! – jordancpaul