Alpha

Javadoc

本指南適用於 Dokka Gradle 外掛程式 (DGP) v2 模式。DGP v1 模式已不再支援。 若要從 v1 升級到 v2 模式，請參閱 遷移指南。

Dokka 的 Javadoc 輸出格式在外觀上與 Java 的 Javadoc HTML 格式 相似。

它嘗試在視覺上模仿 Javadoc 工具產生的 HTML 頁面，但並非直接實作或完全複製。

所有 Kotlin 程式碼與簽章都會以 Java 的視角進行渲染。這是透過我們的 Kotlin as Java Dokka 外掛程式 實作的，該外掛程式已內建並預設套用於此格式。

Javadoc 輸出格式是以 Dokka 外掛程式 的形式實作，並由 Dokka 團隊維護。它是開源的，您可以在 GitHub 上找到原始碼。

產生 Javadoc 文件

Dokka 不支援多專案組建或 Kotlin Multiplatform 專案的 Javadoc 格式。

Gradle Kotlin DSLMavenCLI

Dokka 的 Gradle 外掛程式 已包含 Javadoc 輸出格式。您需要在專案 build.gradle.kts 檔案的 plugins {} 區塊中套用對應的外掛程式 ID：

plugins {
    id("org.jetbrains.dokka-javadoc") version "2.1.0"
}

套用外掛程式後，您可以執行以下任務：

• dokkaGenerate：根據套用的外掛程式，以所有可用格式產生文件。
• dokkaGeneratePublicationJavadoc：僅產生 Javadoc 格式的文件。

可以單獨產生 javadoc.jar 檔案。如需更多資訊，請參閱 建置 javadoc.jar。

Dokka 的 Maven 外掛程式 已內建 Javadoc 輸出格式。您可以使用以下目標 (goal) 產生文件：

目標 (Goal)	說明
dokka:javadoc	產生 Javadoc 格式的文件
dokka:javadocJar	產生包含 Javadoc 格式文件的 javadoc.jar 檔案

由於 Javadoc 輸出格式是一個 Dokka 外掛程式，您需要 下載該外掛程式的 JAR 檔案。

Javadoc 輸出格式有兩個相依性，您需要以額外的 JAR 檔案形式提供：

• kotlin-as-java 外掛程式
• korte-jvm

透過 命令列選項：

java -jar dokka-cli-2.1.0.jar \
     -pluginsClasspath "./dokka-base-2.1.0.jar;...;./javadoc-plugin-2.1.0.jar" \
     ...

透過 JSON 配置：

{
  ...
  "pluginsClasspath": [
    "./dokka-base-2.1.0.jar",
    "...",
    "./kotlin-as-java-plugin-2.1.0.jar",
    "./korte-jvm-3.3.0.jar",
    "./javadoc-plugin-2.1.0.jar"
  ],
  ...
}

如需更多資訊，請參閱 CLI 執行器的文件中的其他輸出格式。