JSDoc



jsdoc

JSDoc

शुरू करना

JSDoc 3 के साथ प्रारंभ करना
जेएसडीओसी के साथ जावास्क्रिप्ट को दस्तावेज करने के लिए एक त्वरित शुरुआत।
JSDoc 3 के साथ namepaths का उपयोग करना
JSDoc 3 के साथ namepaths का उपयोग करने के लिए एक गाइड।
JSDoc के लिए कमांड लाइन तर्क
JSDoc को कमांड लाइन तर्क के बारे में।
कॉन्फ़िगरेशन फ़ाइल के साथ JSDoc को कॉन्फ़िगर करना
कॉन्फ़िगरेशन फ़ाइल का उपयोग कर JSDoc को कॉन्फ़िगर कैसे करें।
JSDoc के डिफ़ॉल्ट टेम्पलेट को कॉन्फ़िगर करना
JSDoc के डिफ़ॉल्ट टेम्पलेट से आउटपुट को कॉन्फ़िगर कैसे करें।
ब्लॉक और इनलाइन टैग
ब्लॉक और इनलाइन JSDoc टैग का अवलोकन।
जेएसडीओसी प्लगइन्स के बारे में
JSDoc प्लगइन्स कैसे बनाएं और उपयोग करें।
मार्कडाउन प्लगइन का उपयोग करना
JSDoc में मार्कडाउन समर्थन सक्षम करें।
Tutorials
अपने एपीआई दस्तावेज में ट्यूटोरियल जोड़ना।
एक पैकेज फ़ाइल सहित
अपने दस्तावेज़ में पैकेज विवरण कैसे दिखाएं।
एक रीडमे फ़ाइल सहित
अपने दस्तावेज़ में एक README फ़ाइल कैसे शामिल करें।
License
JSDoc 3 के लिए लाइसेंस जानकारी।

जेएसडीओसी उदाहरण

ईएस 2015 कक्षाएं
ईसीएमएस्क्रिप्ट 2015 कक्षाओं में जेएसडीओसी टिप्पणियां कैसे जोड़ें।
ईएस 2015 मॉड्यूल
ECMAScript 2015 मॉड्यूल में JSDoc टिप्पणियां कैसे जोड़ें।
कॉमनजेएस मॉड्यूल
CommonJS और Node.js मॉड्यूल में JSDoc टिप्पणियां कैसे जोड़ें।
एएमडी मॉड्यूल
एएमडी और RequJS मॉड्यूल में JSDoc टिप्पणियां कैसे जोड़ें।

ब्लॉक टैग

@abstract (समानार्थक शब्द: @ virtual)
इस सदस्य को उत्तराधिकारी द्वारा लागू (या ओवरराइड) किया जाना चाहिए।
@access
इस सदस्य का उपयोग स्तर निर्दिष्ट करें (निजी, पैकेज-निजी, सार्वजनिक, या संरक्षित)।
@alias
एक सदस्य का इलाज करें जैसे कि इसका एक अलग नाम था।
@async
इंगित करें कि एक समारोह असीमित है।
@augments (समानार्थी शब्द: @extends)
इंगित करें कि एक प्रतीक विरासत से प्राप्त होता है, और जोड़ता है।
@author
किसी आइटम के लेखक की पहचान करें।
@borrows
यह वस्तु किसी अन्य वस्तु से कुछ उपयोग करती है।
@callback
एक कॉलबैक समारोह दस्तावेज।
@class (समानार्थी शब्द: @constructor)
इस समारोह को "नया" कीवर्ड के साथ बुलाया जाना है।
@classdesc
पूरे वर्ग का वर्णन करने के लिए निम्न पाठ का प्रयोग करें।
@constant (समानार्थी शब्द: @const)
ऑब्जेक्ट को स्थिर के रूप में दस्तावेज़ करें।
@constructs
यह कार्य सदस्य पिछली कक्षा के लिए निर्माता होगा।
@copyright
कुछ कॉपीराइट जानकारी दस्तावेज।
@default (समानार्थी शब्द: @defaultvalue)
डिफ़ॉल्ट मान दस्तावेज करें।
@deprecated
दस्तावेज है कि यह अब पसंदीदा तरीका नहीं है।
@description (समानार्थी शब्द: @ डीएससी)
एक प्रतीक का वर्णन करें।
@enum
संबंधित गुणों का संग्रह दस्तावेज करें।
@event
एक घटना दस्तावेज।
@example
एक दस्तावेज आइटम का उपयोग कैसे करें इसका एक उदाहरण प्रदान करें।
@exports
जावास्क्रिप्ट मॉड्यूल द्वारा निर्यात किए गए सदस्य की पहचान करें।
@external (समानार्थी शब्द: @ होस्ट)
एक बाहरी वर्ग, नामस्थान, या मॉड्यूल की पहचान करता है।
@file (समानार्थी शब्द: @fileoverview, @overview)
एक फाइल का वर्णन करें।
@fires (समानार्थी शब्द: @emits)
इस विधि को आग लगने वाली घटनाओं का वर्णन करें।
@function (समानार्थी शब्द: @func, @method)
एक समारोह या विधि का वर्णन करें।
@generator
इंगित करें कि एक फ़ंक्शन जनरेटर फ़ंक्शन है।
@global
एक वैश्विक वस्तु दस्तावेज।
@hideconstructor
इंगित करें कि निर्माता को प्रदर्शित नहीं किया जाना चाहिए।
@ignore
प्रलेखन से एक प्रतीक छोड़ दें।
@implements
यह प्रतीक एक इंटरफ़ेस लागू करता है।
@inheritdoc
इंगित करें कि एक प्रतीक को अपने माता-पिता के दस्तावेज़ों का उत्तराधिकारी होना चाहिए।
@inner
एक आंतरिक वस्तु दस्तावेज।
@instance
एक उदाहरण सदस्य दस्तावेज।
@interface
यह प्रतीक एक इंटरफेस है जिसे अन्य लागू कर सकते हैं।
@kind
यह किस तरह का प्रतीक है?
@lends
ऑब्जेक्ट पर दस्तावेज गुणों का शाब्दिक अर्थ है कि वे किसी दिए गए नाम के साथ प्रतीक से संबंधित हैं।
@license
इस कोड पर लागू होने वाले लाइसेंस की पहचान करें।
@listens
उन घटनाओं की सूची बनाएं जिनके लिए प्रतीक सुनता है।
@member (समानार्थी शब्द: @var)
एक सदस्य दस्तावेज।
@memberof
यह प्रतीक एक मूल प्रतीक से संबंधित है।
@mixes
यह वस्तु किसी अन्य वस्तु से सभी सदस्यों में मिलती है।
@mixin
एक मिश्रण वस्तु दस्तावेज।
@module
एक जावास्क्रिप्ट मॉड्यूल दस्तावेज।
@name
ऑब्जेक्ट का नाम दस्तावेज करें।
@namespace
एक नामस्थान वस्तु दस्तावेज।
@override
इंगित करें कि एक प्रतीक अपने माता-पिता को ओवरराइड करता है।
@package
यह प्रतीक पैकेज-निजी होने के लिए है।
@param (समानार्थी शब्द: @arg, @argument)
एक समारोह में पैरामीटर दस्तावेज।
@private
यह प्रतीक निजी होने के लिए है।
@property (समानार्थी शब्द: @prop)
ऑब्जेक्ट की एक संपत्ति दस्तावेज करें।
@protected
यह प्रतीक संरक्षित करने के लिए है।
@public
यह प्रतीक सार्वजनिक होना है।
@readonly
यह प्रतीक केवल पढ़ने के लिए है।
@requires
इस फ़ाइल को एक जावास्क्रिप्ट मॉड्यूल की आवश्यकता है।
@returns (समानार्थी शब्द: @return)
किसी फ़ंक्शन का रिटर्न वैल्यू दस्तावेज करें।
@see
अधिक जानकारी के लिए कुछ अन्य दस्तावेज देखें।
@since
यह सुविधा कब जोड़ा गया था?
@static
एक स्थिर सदस्य दस्तावेज।
@summary
पूर्ण विवरण का एक छोटा संस्करण।
@this
'यह' कीवर्ड यहां क्या संदर्भित करता है?
@throws (समानार्थी शब्द: @exception)
वर्णन करें कि क्या त्रुटियां फेंक दी जा सकती हैं।
@todo
दस्तावेज़ कार्य पूरा होने के लिए।
@tutorial
एक शामिल ट्यूटोरियल फ़ाइल के लिए एक लिंक डालें।
@type
ऑब्जेक्ट के प्रकार को दस्तावेज़ करें।
@typedef
एक कस्टम प्रकार दस्तावेज।
@variation
एक ही नाम के साथ विभिन्न वस्तुओं को अलग करें।
@version
किसी आइटम की संस्करण संख्या दस्तावेज़।
@yields (समानार्थी शब्द: @yield)
जनरेटर फ़ंक्शन द्वारा प्रदत्त मान को दस्तावेज़ करें।

इनलाइन टैग

{@link} (समानार्थक शब्द: {@ लिंककोड}, {@ लिंकनप्लेन})
दस्तावेज में किसी अन्य आइटम से लिंक करें।
{@tutorial}
एक ट्यूटोरियल से लिंक करें।

योगदान

गिटहब पर जेएसडीओसी परियोजना
JSDoc में योगदान दें।
गिटहब पर जेएसडीओसी प्रोजेक्ट का प्रयोग करें
JSDoc दस्तावेज़ में योगदान दें।

GitHub पर मेरे कांटा