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

Dokka, JetBrains द्वारा विकसित Kotlin भाषा के लिए एक आधुनिक डॉक्यूमेंटेशन जनरेशन इंजन है। पारंपरिक JavaDoc के विपरीत, Dokka Kotlin की विशिष्टताओं को समझता है: null-सुरक्षा, एक्सटेंशन फंक्शन, प्रॉपर्टीज, कोरूटीन, sealed-क्लास और भाषा की अन्य अनूठी संरचनाएं। यदि आप Kotlin में कोई लाइब्रेरी या API लिख रहे हैं, तो Dokka स्वचालित रूप से HTML, Markdown, Javadoc या JSON फॉर्मेट में पठनीय और संरचित डॉक्यूमेंटेशन तैयार कर सकता है।

इसकी आवश्यकता क्यों है? सबसे पहले, Dokka बड़े प्रोजेक्ट्स में डॉक्यूमेंटेशन को बनाए रखना बहुत आसान बनाता है - बस कोड में KDoc कमेंट्स (JavaDoc का एक एनालॉग, लेकिन Markdown सपोर्ट के साथ) लिखें, और यह टूल एक तैयार वेबसाइट जनरेट कर देगा। दूसरा, Dokka कई Gradle या Maven मॉड्यूल से डॉक्यूमेंटेशन को एक ही प्रोजेक्ट में मर्ज कर सकता है, जो मल्टी-मॉड्यूल लाइब्रेरीज के लिए महत्वपूर्ण है। तीसरा, यह टेम्पलेट्स और प्लगइन्स के माध्यम से कस्टमाइज़ेशन को सपोर्ट करता है, जिससे आप लुक को कॉर्पोरेट स्टाइल के अनुसार अनुकूलित कर सकते हैं।

Dokka का उपयोग Kotlin की आधिकारिक डॉक्यूमेंटेशन (kotlinlang.org), Ktor, Exposed, Kotlinx.serialization और कई अन्य लाइब्रेरीज में सक्रिय रूप से किया जाता है। यह Kotlin प्रोजेक्ट्स को डॉक्यूमेंट करने का डी-फैक्टो मानक है, और यदि आप चाहते हैं कि आपकी लाइब्रेरी प्रोफेशनल दिखे - तो Dokka सीखना अनिवार्य है।

2. इंस्टॉलेशन

Dokka Gradle और Maven बिल्ड सिस्टम के लिए एक प्लगइन के रूप में वितरित किया जाता है। इसके लिए कोई अलग pip या npm कमांड नहीं है, क्योंकि यह JVM इकोसिस्टम का टूल है। नीचे Gradle (Kotlin DSL) के लिए सटीक निर्देश दिए गए हैं - यह सबसे लोकप्रिय तरीका है।

Gradle (Kotlin DSL) - एक मॉड्यूल के लिए प्लगइन

build.gradle.kts में जोड़ें:

plugins {
    id("org.jetbrains.dokka") version "1.9.20"
}

dependencies {
    // आपकी डिपेंडेंसीज
}

// बेसिक कॉन्फ़िगरेशन (वैकल्पिक)
tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>() {
    outputDirectory.set(file("$buildDir/dokka"))
}

Gradle (Groovy DSL)

plugins {
    id "org.jetbrains.dokka" version "1.9.20"
}

Maven

<plugin>
    <groupId>org.jetbrains.dokka</groupId>
    <artifactId>dokka-maven-plugin</artifactId>
    <version>1.9.20</version>
    <executions>
        <execution>
            <phase>pre-site</phase>
            <goals>
                <goal>dokka</goal>
            </goals>
        </execution>
    </executions>
</plugin>

सेटअप के बाद, यह कमांड चलाएं:

./gradlew dokkaHtml       # HTML के लिए
./gradlew dokkaGfm        # Markdown (GFM) के लिए
./gradlew dokkaJavadoc    # Javadoc-स्टाइल के लिए

3. त्वरित शुरुआत - न्यूनतम कार्यशील उदाहरण

KDoc कमेंट्स के साथ एक सरल Kotlin फ़ाइल बनाएं:

// src/main/kotlin/com/example/Calculator.kt
package com.example

/**
 * एक सरल कैलकुलेटर जो Dokka के काम को प्रदर्शित करता है।
 *
 * @author PythonLib Team
 * @since 1.0.0
 */
class Calculator {

    /**
     * दो संख्याओं को जोड़ता है।
     *
     * @param a पहला जोड़
     * @param b दूसरा जोड़
     * @return a और b का योग
     */
    fun add(a: Int, b: Int): Int = a + b

    /**
     * एक संख्या को दूसरी संख्या से विभाजित करता है।
     *
     * @param a भाज्य
     * @param b भाजक (शून्य नहीं हो सकता)
     * @return विभाजन का परिणाम
     * @throws IllegalArgumentException यदि b == 0
     */
    fun divide(a: Double, b: Double): Double {
        require(b != 0.0) { "भाजक शून्य नहीं हो सकता" }
        return a / b
    }
}

./gradlew dokkaHtml चलाएं। build/dokka फ़ोल्डर में जनरेटेड HTML डॉक्यूमेंटेशन देखें।