2010-12-17 195 views

回答

197
  1. 項目>生成Javadoc ......

  2. 的Javadoc命令:字段中,瀏覽找到的javadoc.exe(通常在[path_to_jdk_directory] ​​\ BIN \的javadoc.exe)。

  3. 選中您要爲其創建Javadoc的項目/包/文件旁邊的框。

  4. 目的地:字段中,瀏覽找到所需的目的地(例如,當前項目的根目錄)。

  5. 點擊完成

您現在應該能夠在目標文件夾中找到新生成的Javadoc。 打開index.html

+0

是否在Java JDK需要被安裝?我安裝了Java並可以在Eclipse中創建Java程序......但是'javadoc.exe'不存在於我的驅動器上的任何位置! – AlainD 2017-01-07 23:36:43

8

簡單,可靠的解決方案中添加的Javadoc在Eclipse:

  1. 轉到幫助>Eclipse的市場......
  2. 找到「JAutodoc」。
  3. 安裝並重新啓動Eclipse。

要使用此工具,請右鍵點擊課程並點擊JAutodoc

+2

AFAIK,JAutodoc不會產生現有javadoc註釋(這是個問題問什麼),HTML,而是幫助生成javadoc註釋。 – 2016-04-18 07:13:34

+1

答案與問題無關,但這正是我正在尋找的:) – keya 2016-07-23 18:54:37

104

How to generate Javadoc in Eclipse?

  1. 打開Eclipse項目文件夾中。

  2. 選擇項目>生成Javadoc ......

  • 在嚮導的第一步驟中,可以爲定義設置:

    3.1。從JDK中選擇javadoc.exe工具的路徑。
    3.2。要爲其生成Javadoc的項目資源。
    3.3。基於其可見性生成Javadoc的類和方法。
    3.4。 Javadoc的位置(默認情況下,它將放置在項目位置的doc文件夾中)。

  • 在第二步驟可以關於使設置:

    4.1。文件名。
    4.2。文檔結構。
    4.3。選擇要處理的文檔標籤。
    4.4。項目中使用的其他資源(檔案,項目)將包含在文檔中。
    4.5。爲您的文檔選擇CSS樣式表。

  • 在最終的步驟,你可以保存以備將來使用一個Ant腳本的設置。
  • -1

    要快速添加的Javadoc使用以下快捷:

    的WindowsALT + 轉變 + Ĵ

    的Mac + Alt鍵 + Ĵ

    根據所選上下文中,Javadoc將被打印。要創建由OP編寫的Javadoc,請選擇相應的方法並按下Shotcut鍵。

    1

    您也可以通過命令行做要容易。從文件夾/包

    1. 打開命令行。
    2. 運行命令行:

      的javadoc YourClassName.java

    3. 要批量生成多個類別的文檔:

      的javadoc *的.java