Javadoc

Javadoc 輸出格式仍處於 Alpha 階段，因此您在使用時可能會發現錯誤並遇到遷移問題。 不保證與接受 Java Javadoc HTML 作為輸入的工具成功整合。 您需自行承擔使用風險。

Dokka 的 Javadoc 輸出格式是 Java Javadoc HTML 格式 的模擬。

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

所有 Kotlin 程式碼和簽章都從 Java 的視角呈現。這是透過我們的 Kotlin as Java Dokka 外掛 實現的，該外掛預設已捆綁並套用於此格式。

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

產生 Javadoc 文件

Javadoc 格式不支援多平台專案。

GradleMavenCLI

Dokka 的 Gradle 外掛 隨附 Javadoc 輸出格式。您可以使用以下任務：

任務	說明
dokkaJavadoc	為單一專案產生 Javadoc 文件。
dokkaJavadocCollector	僅為多專案建構中的父專案建立的 Collector 任務。它會為每個子專案呼叫 dokkaJavadoc 並將所有輸出合併到一個單一的虛擬專案中。

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

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

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

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

Javadoc 輸出格式有兩個相依性，您需要將它們作為額外的 JAR 檔案提供：

• kotlin-as-java plugin
• korte-jvm

透過 命令列選項：

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

透過 JSON 設定：

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

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