獲取JavaDocs生成的HTML文件

Question

據我所知， Javadoc是Sun Microsystems的文檔生成器，用於從Java源代碼生成HTML格式的API文檔。 我推斷文檔存儲在HTML文件中。

有沒有辦法可以訪問它？

如果是，它存儲在哪里？

Answer 1

Javadoc這個詞可以參考

• Java源文件中的特殊注釋（在聲明之前，形式為/** ... */ ）
• 將這些注釋（以及聲明本身）轉換為可讀輸出的程序
• 輸出本身，通常是HTML格式。

Javadoc程序包含在Sun（或現在的Oracle）Java Development Kit（JDK）中。

如果已經安裝了JDK（如果進行Java開發則應該使用它），可以在命令行上調用它，將包名稱傳遞給文檔或某些源文件名。 您還應使用-d選項指示輸出目錄。

我在下面的示例中假設以下目錄（和包）結構：

• 當前目錄
  • 資源
    • 德
      • dclj
        • 保羅
          • 例子
            • HelloWorld.java [包含package de.dclj.paul.examples; 和public class HelloWorld { ... } ]
  • 文檔

然后使用以下命令行：

 javadoc -sourcpath source -d docs de.dclj.paul.examples 

然后，它將在docs目錄中創建一個文檔，其中index.html可以在Web瀏覽器中打開，還可以從其中訪問其他文件。

有關更多詳細信息，請查看上面鏈接的文檔。 有關示例輸出，請查看Java Standard API Javadoc 。

如果您使用的是IDE，那么您可能會在其中生成Javadoc按鈕，IDE甚至可能會動態顯示單個類或方法的文檔的格式化輸出。