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

Dokka का परिचय: यह क्या है और क्यों ज़रूरी है

Dokka एक शक्तिशाली टूल है जो Kotlin भाषा में लिखे सोर्स कोड से डॉक्यूमेंटेशन जनरेट करता है। JetBrains कंपनी द्वारा विकसित, Dokka Kotlin प्रोजेक्ट्स के लिए आधिकारिक डॉक्यूमेंटेशन सॉल्यूशन है। यह आपके कोड का विश्लेषण करता है, उसमें से KDoc कमेंट्स (Kotlin के लिए JavaDoc का विकल्प) निकालता है, और विभिन्न फॉर्मेट्स में स्ट्रक्चर्ड डॉक्यूमेंटेशन जनरेट करता है: HTML, Markdown, Javadoc और अन्य।

Dokka की ज़रूरत क्यों है?

ऑटोमेशन: आपको मैन्युअली डॉक्यूमेंटेशन लिखने की ज़रूरत नहीं है। Dokka आपके कोड और कमेंट्स के आधार पर इसे जनरेट करता है।
अप-टू-डेट: डॉक्यूमेंटेशन हमेशा कोड के अनुरूप होती है, क्योंकि यह सीधे कोड से जनरेट होती है।
Kotlin Multiplatform सपोर्ट: Dokka मल्टीप्लेटफॉर्म प्रोजेक्ट्स के साथ बेहतरीन काम करता है, विभिन्न मॉड्यूल्स (common, jvm, js, native) से डॉक्यूमेंटेशन को जोड़ता है।
लचीलापन: आप लुक, आउटपुट फॉर्मेट को कस्टमाइज़ कर सकते हैं और कोड के कुछ हिस्सों को शामिल या बाहर कर सकते हैं।
इंटीग्रेशन: Gradle और Maven बिल्ड सिस्टम के साथ आसानी से इंटीग्रेट होता है।

Dokka लाइब्रेरी, API और बड़े प्रोजेक्ट्स के डेवलपर्स के लिए अपरिहार्य है, जहाँ उपयोगकर्ताओं के लिए गुणवत्तापूर्ण डॉक्यूमेंटेशन बहुत महत्वपूर्ण है।

Dokka की स्थापना (Installation)

Dokka pip या npm के माध्यम से इंस्टॉल नहीं होता, क्योंकि यह Kotlin/JVM इकोसिस्टम का टूल है। इसे इंस्टॉल करने का मुख्य तरीका Gradle (अनुशंसित) या Maven बिल्ड सिस्टम के माध्यम से है।

Gradle (Kotlin DSL) के माध्यम से इंस्टॉलेशन


// build.gradle.kts
plugins {
    id("org.jetbrains.dokka") version "1.9.20" // नवीनतम वर्जन जाँचें
}

// या apply plugin के माध्यम से:
// apply(plugin = "org.jetbrains.dokka")

Gradle (Groovy DSL) के माध्यम से इंस्टॉलेशन


// build.gradle
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>compile</phase>
            <goals><goal>dokka</goal></goals>
        </execution>
    </executions>
</plugin>

त्वरित शुरुआत: पहला रन

प्लगइन कनेक्ट करने के बाद, आपको अपने कोड में कुछ KDoc कमेंट्स लिखने होंगे और Gradle टास्क चलाना होगा।

चरण 1: कमेंट्स के साथ कोड लिखें


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

/**
 * एक सरल कैलकुलेटर जो बुनियादी अंकगणितीय ऑपरेशन करता है।
 *
 * @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 dividend भाज्य (विभाजित होने वाली संख्या)।
     * @param divisor भाजक (विभाजित करने वाली संख्या)। शून्य नहीं हो सकता।
     * @return विभाजन का परिणाम।
     * @throws IllegalArgumentException यदि divisor शून्य है।
     */
    fun divide(dividend: Double, divisor: Double): Double {
        if (divisor == 0.0) throw IllegalArgumentException("Divisor cannot be zero")
        return dividend / divisor
    }
}