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為文檔入口

 

打開后如下:

 


人生在世,雜事七八;飯要少吃,事要多知;抽個時間,總結一下;樂在分享,自在提升

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM