JavaDoc文檔生成

JavaDoc文檔

JavaDoc是Sun公司提供的一種將注釋生成HTML文檔的技術，生成的HTML文檔類似於Java的API

注釋標簽

標記	說明	標簽類型
@author 作者	作者標識	包、類、接口
@version 版本號	版本號	包、類、接口
@param 參數名 描述	方法的入參名及描述信息，如入參有特別要求，可在此注釋。	構造函數、方法
@return 描述	對函數返回值的注釋	方法
@deprecated 過期文本	標識隨着程序版本的提升，當前API已經過期，僅為了保證兼容性依然存在．以此告之開發者不應再用這個API。	包、類、接口、值域、構造函數、方法
@throws 異常類名	構造函數或方法所會拋出的異常。	構造函數、方法
@exception 異常類名	同@throws	構造函數、方法
@see 引用	查看相關內容，如類，方法，變量等。	包、類、接口、值域、構造函數、方法
@since 描述文本	API在什么程序的什么版本后開發支持。	包、類、接口、值域、構造函數、方法
{@link 包.類#成員 標簽}	鏈接到某個特定的成員對應的文檔中。	包、類、接口、值域、構造函數、方法
{@value}	當對常量進行注釋時，如果想將其值包含在文檔中，則通過該標簽來引用常量的值。	靜態值域

此外還有@serial、@serialField、@serialData、{@docRoot)、{@inheritDoc)、{@lteral})、{@code} {@value arg}幾個不常用的

命令行生成JavaDoc文檔

1. 在資源管理器中打開想要生成JavaDoc文檔的java文件目錄
   
   
    

2. 在地址欄前面輸入cmd+空格+回車打開命令行窗口
   
   
   

3. 在窗口輸入javadoc -encoding utf-8 -charset utf-8 java文件，回車 
   
   
   

IDEA生成JavaDoc文檔

1. 打開IDEA，點擊Tools >> Generate JavaDoc，打開生成JavaDoc文檔的配置頁面 
   
   
   
   

2. 進行配置 
   
   
   

　　　　　　　　　注釋:

序號	解釋
1	文檔生成范圍
2	文檔輸出路徑
3	文檔生成語言
4	傳入JavaDoc的參數，一般這樣寫 -encoding utf-8 -charset utf-8 -windowtitle “文檔HTML頁面標簽的標題” -link http://docs.Oracle.com/javase/8/docs/api

 

3. 按要求填寫好后點擊OK