Java Doc

Javadoc命令是用來生產自己API文檔的

參數信息

• @author作者名
• @version 版本號
• @since 指明需要最早使用的JDK版本
• @param參數名
• @return返回值情況
• @throws異常拋出情況

idea生成javadoc文檔

1.idea上方選擇Tools->Generate JavaDoc

• 1.選擇整個項目還是單個模塊

• 2.生成文檔放的位置

• 3.選擇地區語言 zh-CN（中文）

• 4.-encoding UTF-8 -charset UTF-8 -author -version -windowtitle ” “

  注意參數裏面的「 」裏面就是你生成的JavaDoc存放的指定目錄（就是2）

然後點ok即可

[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-ZohqBxLe-1645325543290)(D:\瀏覽器下載內容\csdn2.png)]

cmd生成javaDoc文檔

1.右鍵需要生成的項目->show in explorer[外鏈圖片轉存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-XQaN6HdG-1645325543290)(D:\瀏覽器下載內容\csdn3.png)]

2.在該路徑前加cmd (和路徑中間有空格)

3.在cmd中輸入 javadoc -encoding UTF-8 -charset UTF-8 Doc.java(需要生成的項目名)

(有中文需要轉成UTF-8)

若出現『javadoc『 不是內部或外部命令，也不是可運行的程序 或批處理文件。則是環境變量沒有配置，配置環境變量即可