TypeDoc TypeScript: तरीके, उदाहरण, इंस्टॉलेशन

TypeDoc क्या है और इसकी आवश्यकता क्यों है?

TypeDoc एक शक्तिशाली डॉक्यूमेंटेशन जनरेटर है जो TypeScript प्रोजेक्ट्स के लिए बनाया गया है। यह आपके कोड में JSDoc फॉर्मेट में लिखे गए कमेंट्स के आधार पर स्वचालित रूप से सुंदर, संरचित HTML पेज तैयार करता है। अगर आपने कभी TypeScript में कोड लिखा है और आधिकारिक TypeScript डॉक्यूमेंटेशन या लोकप्रिय लाइब्रेरीज़ जैसी डॉक्यूमेंटेशन जल्दी से चाही है, तो TypeDoc आपके लिए ही है।

इसकी आवश्यकता क्यों है? आधुनिक डेवलपमेंट में डॉक्यूमेंटेशन कोई विलासिता नहीं, बल्कि एक आवश्यकता है। TypeDoc कई महत्वपूर्ण कार्यों को हल करता है:

ऑटोमेशन: आपको मैन्युअली डॉक्यूमेंटेशन लिखने की ज़रूरत नहीं। बस फंक्शन, क्लास, इंटरफेस और टाइप्स में कमेंट जोड़ें, और TypeDoc एक तैयार वेबसाइट जनरेट कर देगा।
अपडेटेड रहना: डॉक्यूमेंटेशन हमेशा कोड के अनुरूप होती है, क्योंकि यह सीधे कोड से जनरेट होती है।
नेविगेशन: TypeDoc प्रोजेक्ट में आसान नेविगेशन बनाता है: ट्री स्ट्रक्चर, सर्च, और टाइप्स के लिंक।
TypeScript सपोर्ट: यह TypeScript के जटिल टाइप्स को समझता है: जेनेरिक्स, यूटिलिटी टाइप्स, फंक्शन ओवरलोड्स, मॉड्यूल और नेमस्पेस।
एक्सटेंसिबिलिटी: TypeDoc थीम, प्लगइन और कस्टमाइज़ेशन को सपोर्ट करता है।

TypeDoc निम्नलिखित के लिए आदर्श है:

npm के माध्यम से वितरित लाइब्रेरीज़ और पैकेज।
आंतरिक प्रोजेक्ट्स, जहाँ नए डेवलपर्स को जल्दी से कोड से परिचित कराना हो।
TypeScript पर सर्वर-साइड एप्लिकेशन के लिए API डॉक्यूमेंटेशन।
शैक्षिक प्रोजेक्ट्स, जहाँ स्पष्टता महत्वपूर्ण है।

TypeDoc की स्थापना (इंस्टॉलेशन)

TypeDoc को npm (Node Package Manager) के माध्यम से स्थापित किया जाता है। सुनिश्चित करें कि आपके पास Node.js (संस्करण 14 या उच्चतर) स्थापित है।

सबसे आसान तरीका है TypeDoc को ग्लोबली स्थापित करना:

npm install -g typedoc

हालांकि, प्रोजेक्ट्स के लिए इसे डेवलपमेंट डिपेंडेंसी के रूप में स्थापित करने की सिफारिश की जाती है:

npm install --save-dev typedoc

स्थापना के बाद, आप संस्करण की जांच कर सकते हैं:

npx typedoc --version

अगर आप Yarn का उपयोग कर रहे हैं:

yarn add -D typedoc

pnpm के लिए:

pnpm add -D typedoc

कोड उदाहरण के साथ त्वरित शुरुआत

चलिए एक सरल प्रोजेक्ट बनाते हैं और उसके लिए डॉक्यूमेंटेशन जनरेट करते हैं।

चरण 1: प्रोजेक्ट बनाएं

mkdir my-typedoc-project
cd my-typedoc-project
npm init -y

चरण 2: TypeDoc स्थापित करें

npm install --save-dev typedoc

चरण 3: कोड फ़ाइल बनाएं src/index.ts

/**
 * गणितीय संक्रियाओं के लिए मॉड्यूल।
 * @module MathUtils
 */

/**
 * दो संख्याओं को जोड़ता है।
 * @param a - पहली संख्या
 * @param b - दूसरी संख्या
 * @returns a और b का योग
 * @example
 * ```typescript
 * const result = add(2, 3);
 * console.log(result); // 5
 * ```
 */
export function add(a: number, b: number): number {
    return a + b;
}

/**
 * पहली संख्या में से दूसरी संख्या घटाता है।
 * @param a - घटाव में आने वाली संख्या
 * @param b - घटाने वाली संख्या
 * @returns a और b का अंतर
 */
export function subtract(a: number, b: number): number {
    return a - b;
}

/**
 * द्वि-आयामी स्थान में एक बिंदु को दर्शाने के लिए इंटरफ़ेस।
 */
export interface Point {
    /** X निर्देशांक */
    x: number;
    /** Y निर्देशांक */
    y: number;
}

/**
 * दो बिंदुओं के बीच की दूरी की गणना करता है।
 * @param p1 - पहला बिंदु
 * @param p2 - दूसरा बिंदु
 * @returns बिंदुओं के बीच की दूरी
 */
export function distance(p1: Point, p2: Point): number {
    const dx = p2.x - p1.x;
    const dy = p2.y - p1.y;
    return Math.sqrt(dx * dx + dy * dy);
}

चरण 4: डॉक्यूमेंटेशन जनरेट करें