Dart Academy · पाठ

dartdoc Comments से Documentation

ऐसे docs लिखें जो pub.dev पर दिखाई दें

पाठ 2, कुल 4 में से13 चरण

dartdoc Comments से Documentation, CoddyKit पर Dart Academy का एक निःशुल्क पाठ है। यह 4 में से 2वाँ पाठ है। आप नीचे पूरा पाठ निःशुल्क पढ़ सकते हैं—फिर अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर के साथ ब्राउज़र में इसका व्यावहारिक अभ्यास कर सकते हैं। यह Dart Academy सीखने के मार्ग का हिस्सा है और आपकी प्रगति वेब तथा CoddyKit ऐप पर सिंक होती रहती है। Dart Academy पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

दस्तावेज़ उत्पाद का हिस्सा हैं

बेहतरीन पैकेज बेहतरीन दस्तावेज़ों के साथ आते हैं। Dart विशेष टिप्पणियों को ब्राउज़ की जा सकने वाली संदर्भ सामग्री में बदलता है, इसलिए दस्तावेज़ीकरण कोई बाद में जोड़ी जाने वाली चीज़ नहीं, बल्कि प्रथम-श्रेणी की सुविधा है। 📝

ट्रिपल-स्लैश दस्तावेज़ी टिप्पणियाँ

दस्तावेज़ी टिप्पणी तीन स्लैश से शुरू होती है। ये दस्तावेज़ी टिप्पणियाँ किसी घोषणा के ठीक ऊपर रहती हैं और उपयोगकर्ताओं को बताती हैं कि वह क्या करती है।

/// Adds two numbers and returns the sum.
int add(int a, int b) => a + b;

एक ही सारांश पंक्ति से शुरुआत करें

हर दस्तावेज़ी टिप्पणी की शुरुआत एक छोटे सारांश वाक्य से करें। उपकरण सूचियों में यही पहली पंक्ति दिखाते हैं, इसलिए इसे अपने-आप में स्पष्ट और पूरा रखें।

Markdown समर्थित है

दस्तावेज़ी टिप्पणियाँ Markdown स्वीकार करती हैं, इसलिए आप ज़ोर, सूचियाँ और लिंक जोड़ सकते हैं। pub.dev पर आपका रेंडर किया गया पृष्ठ लगभग बिना प्रयास के सुघड़ दिखता है।

/// Returns the **first** matching item.

अन्य प्रतीकों से लिंक करें

किसी नाम को वर्गाकार कोष्ठकों में लपेटकर एक सक्रिय परस्पर-लिंक बनाएँ। पाठक आपके जनरेट किए गए दस्तावेज़ों में संबंधित क्लास या विधियों पर सीधे पहुँच जाते हैं।

/// See [add] for the inverse of [subtract].

फ़ेंस किए गए ब्लॉक में कोड उदाहरण

अपनी टिप्पणी में फ़ेंस किए गए कोड ब्लॉक के अंदर वास्तविक उपयोग दिखाएँ। एक छोटा उदाहरण अनुच्छेदों की तुलना में जल्दी सिखाता है और उपयोगकर्ताओं को भरोसा दिलाता है कि यह काम करता है।

हर सार्वजनिक सदस्य का दस्तावेज़ीकरण करें

हर सार्वजनिक क्लास, फ़ंक्शन और फ़ील्ड का दस्तावेज़ीकरण करने का लक्ष्य रखें। निजी अंडरस्कोर सदस्यों को बिना टिप्पणी के छोड़ा जा सकता है, लेकिन एक्सपोर्ट की गई हर चीज़ एक वाक्य की हकदार है।

लाइब्रेरी-स्तरीय दस्तावेज़

पूरी लाइब्रेरी का वर्णन करने के लिए लाइब्रेरी निर्देश के ऊपर दस्तावेज़ी टिप्पणी रखें। यह लाइब्रेरी टिप्पणी आपके API के उस हिस्से के आरंभिक पाठ के रूप में दिखाई देती है।

/// Math helpers for everyday use.
library calc;

dartdoc से साइट जनरेट करें

अपनी टिप्पणियों को स्थिर वेबसाइट में बदलने के लिए dartdoc उपकरण चलाएँ। प्रकाशित करते समय pub.dev इसे आपके लिए अपने-आप चलाता है।

dart doc .

दस्तावेज़ी कवरेज से अंक मिलते हैं

pub.dev अच्छे दस्तावेज़ वाले पैकेजों को पुरस्कृत करता है। अधिक दस्तावेज़ी कवरेज आपका स्कोर बढ़ाती है और निर्भरता चुनने वाले लोगों को गुणवत्ता का संकेत देती है। ⭐

दस्तावेज़ों को कोड के पास रखें

दस्तावेज़ी टिप्पणियाँ कोड के साथ रहती हैं, इसलिए उन्हें साथ-साथ अपडेट करना आसान होता है। पुराने दस्तावेज़ों को बग की तरह मानें और व्यवहार बदलने पर उन्हें ठीक करें।

त्वरित जाँच

Dart किस टिप्पणी शैली को दस्तावेज़ी टिप्पणी मानता है?

इंटरैक्टिव पाठ में इसका उत्तर दें

पुनरावलोकन: रेंडर होने वाले दस्तावेज़

अब आप ट्रिपल-स्लैश दस्तावेज़ी टिप्पणियाँ लिख सकते हैं, प्रतीकों को लिंक कर सकते हैं, उदाहरण जोड़ सकते हैं और dart doc से साइट जनरेट कर सकते हैं। स्पष्ट दस्तावेज़ उपयोगकर्ताओं का भरोसा जीतते हैं। 🙌

शुरुआत निःशुल्क

एआई शिक्षक के साथ Dart सीखें — निःशुल्क

अपने ब्राउज़र में वास्तविक कोड लिखें और चलाएँ, चौबीसों घंटे एआई शिक्षक से तुरंत सहायता पाएँ, और वेब या ऐप पर वहीं से शुरू करें जहाँ आपने छोड़ा था।

पाठ्यक्रम: 30
पाठ: 120

निःशुल्क सीखना शुरू करें पूरा पाठ्यक्रम देखें

अक्सर पूछे जाने वाले प्रश्न

क्या “dartdoc Comments से Documentation” पाठ निःशुल्क है?

हाँ—“dartdoc Comments से Documentation” का पूरा पाठ यहाँ वेब पर निःशुल्क पढ़ा जा सकता है। इंटरैक्टिव अभ्यास (अंतर्निहित कोड संपादक और 24/7 एआई ट्यूटर) करने और Dart Academy पाठ्यक्रम का बाकी हिस्सा अनलॉक करने के लिए CoddyKit PRO लें। Dart Academy पाठ्यक्रम में कुल 4 पाठ शामिल हैं।

“dartdoc Comments से Documentation” में मैं क्या सीखूँगा?

ऐसे docs लिखें जो pub.dev पर दिखाई दें आप ब्राउज़र में सीधे चलाए जाने वाले व्यावहारिक कोड के साथ Dart Academy का अभ्यास करते हैं, और पाठ पूरा करते समय 24/7 एआई ट्यूटर आपके प्रश्नों के उत्तर देता है।

क्या Dart Academy शुरू करने के लिए मुझे किसी अनुभव की आवश्यकता है?

पहले के अनुभव की आवश्यकता नहीं है। CoddyKit पर Dart Academy शुरुआती से लेकर उन्नत शिक्षार्थियों तक सभी के लिए व्यवस्थित किया गया है, इसलिए आप यहीं से या शुरुआत से सीखना शुरू कर सकते हैं और अपनी गति से आगे बढ़ सकते हैं। यह 4 में से 2वाँ पाठ है।

“dartdoc Comments से Documentation” पाठ पूरा करने में कितना समय लगता है?

CoddyKit का अधिकांश पाठ लगभग 5–10 मिनट में पूरा हो जाता है। हर पाठ छोटा और संवादात्मक है, इसलिए आप लगातार प्रगति करते हैं और वेब या ऐप पर वहीं से सीखना जारी रख सकते हैं जहाँ आपने छोड़ा था।

क्या मैं इस Dart Academy पाठ में कोड लिख और चला सकता हूँ?

हाँ। हर Dart Academy पाठ में एक अंतर्निर्मित कोड संपादक शामिल है, जिससे आप सीधे अपने ब्राउज़र में वास्तविक कोड लिख और चला सकते हैं और तुरंत एआई प्रतिक्रिया पा सकते हैं—स्थानीय सेटअप की आवश्यकता नहीं है।

इस पाठ्यक्रम के सभी पाठ

← Dart Academy पर वापस जाएँ