2012-01-12 12 views
15

क्या जावास्क्रिप्ट के लिए जावाडॉक्स की तरह कुछ है? जब मैं नेटबीन्स आईडीई में ctrl + space दबाता हूं जबकिजावास्क्रिप्ट दस्तावेज़ीकरण

जावास्क्रिप्ट लिखना, जावास्क्रिप्ट दस्तावेज़ निर्दिष्ट ऑब्जेक्ट के लिए बाहर आता है। लेकिन यह दस्तावेज मुझे नेटबीन्स की संपत्ति का अनुमान है।

यदि हम उचित टिप्पणी के तरीके में जावास्क्रिप्ट लिखते हैं, तो नेटबीन्स हमारे कस्टम जावास्क्रिप्ट के लिए दस्तावेज़ भी बनाता है।

क्या हमें नेटबीन्स के बाहर ऐसा कोई जावास्क्रिप्ट दस्तावेज़ मिल सकता है? ताकि हम इसका उल्लेख कर सकें?

उत्तर के लिए धन्यवाद।

उत्तर

11

एक स्थिर संदर्भ के लिए मोज़िला डेवलपर नेटवर्क (MDN) पर दस्तावेज़ पृष्ठों पर एक नज़र डालें:

हालांकि, मैं कर रहा हूँ डर कोई टैब है कि अपूर्णता जिसे आईडीई के अंदर इस्तेमाल किया जा सकता है।

+0

बिल्कुल मुझे जो चाहिए था। – Acn

+9

Google खोज युक्ति: जावास्क्रिप्ट शब्द के बाद "mdn" जोड़ें, उदाहरण के लिए, "substr mdn" और संबंधित MDN पृष्ठ लगभग हमेशा पहला खोज परिणाम होगा। – nnnnnn

+1

मैं आईडीई के अंदर जेएसडोक (जावाडोकिश) के लिए टैब पूर्ण होने पर नहीं छोड़ूंगा। वेबस्टॉर्म का कहना है कि वे इसका समर्थन करते हैं: http://stackoverflow.com/questions/11076572/seeking-example-of-how-to-use-jsdoc-with-the-webstorm-ide-v-4 – SimplGy

8

Google के उनके होमपेज डूडल के स्रोत कोड में, वे टिप्पणियों का उपयोग करते हैं जो जावाडोक टिप्पणियों के समान दिखते हैं, इसलिए कुछ मानक होना चाहिए जो कम से कम Google का उपयोग करता है।

/** 
* Configuration for a simulator speed setting. 
* - stepTime: ms between simulation steps that do something. 
* - emptyStepTime: ms between no-op steps. 
* - tapeTime: ms for a tape operation. 
* - branchTime: ms for a branch operation. 
* @typedef {{stepTime: number, tapeTime: number, emptyStepTime: number, 
*   branchTime: number}} 
* @private 
*/ 
+2

ये [JSDoc] हैं (http://en.wikipedia.org/wiki/JSDoc) टैग, इस मामले में [Google क्लोजर कंपाइलर] (https://developers.google.com/closure/compiler/docs/js-for-compiler) के लिए, इसलिए वे वास्तव में एक कार्यात्मक उद्देश्य की सेवा कर सकते हैं (मुझे लगता है कि संकलक वास्तव में उन्हें लागू करता है, जैसे कि आपके चिपकाए गए उदाहरण में '@ टाइपपीफ' और '@ निजी' टैग)। – Ricket

0

Ortelius नामक एक एप्लिकेशन का प्रयास करें:

यहाँ एक उदाहरण है। यह जेनरेट दस्तावेज के लिए सिंटैक्स जैसे किसी प्रकार का जावाडोक का उपयोग करता है। ortelius.marten.dk

संबंधित मुद्दे