idea 自動生產 api文檔

 

第一：

打開idea，選擇項目。點擊工具欄 Tools->Generate JavaDOC

第二：

 

 

主要分爲三部份內容。

1，Generate JavaDoc scope 要掃描生成api的範圍。

（1）整個項目

（2）單個模塊

（3）單個java類

（4）自定義範圍

 

2，屬性。主要包括文件輸入路徑（指向一個文件夾），class及方法的生產範圍（根據修飾符肯定），要生成的註釋範圍，api文檔生成後的字符

 

3，命令參數 Other command heap size：可添加多個參數。該命令參數主要以javadoc 命令爲主。（後面詳細介紹）

 

以上選擇後點擊 ok 便可生成

 

第三：

javadoc就是jdk內自帶的命令，具體參數你們能夠在cmd命令窗口內輸入 javadoc -help查看

 

 

 

經常使用命令：

 -encoding UTF-8  源代碼字符集格式

-charset UTF-8  生產的javadoc 超文本字符集格式

-windowtitle 「api文檔」  api打開後名稱

 

第四：生成效果以下

 

index.html爲文檔入口

 

打開後以下：

 

---

人生在世，瑣事七八；飯要少吃，事要多知；抽個時間，總結一下；樂在分享，自在提高