Intellij IDEA如何生成JavaDoc

JavaDoc是一種將注釋生成HTML文檔的技術。

1、使用javadoc命令生成文檔

• 首先了解一下javadoc指令的用法

用法: javadoc [options] [packagenames] [sourcefiles] [@files]

 

 使用指令生成文檔，這里的java文件的編碼是utf-8，所以要帶上編碼選項 -encoding utf-8
指令 javadoc -encoding utf-8 Fish.java

 

 打開index.html文件

 

 

 

 

使用eclipse生成文檔

• 選中java文件，右鍵選擇Export，進入Export界面，選Java-Javadoc

 

 點擊Next，選中目錄

 

 兩次一直選擇Next，配置VM options指定源文件編碼為 -encoding utf-8 ， 點擊Finsh

 

 

查看生成文檔過程的信息與文檔

 

 

 

 

 

 3、 Intellij Idea生成JavaDoc

JavaDoc是一種將注釋生成HTML文檔的技術，生成的HTML文檔類似於Java的API，易讀且清晰明了。在簡略介紹JavaDoc寫法之后，再看一下在Intellij Idea 中如何將代碼中的注釋生成HTML文檔。

先看一段樣例代碼：

 1 //: object/Documentation  
 2 /** 這是一個Javadoc測試程序 
 3  *  @author Mike
 4  *  @version 1.0 
 5  *  @since 1.5 
 6  * */  
 7 public class Documentation {  
 8     /**這是一個成員變量 
 9      * */  
10     public String name;  
11     /** a function 
12      * @param name 姓名 
13      * @return 返回name姓名 
14      * @throws  Exception 無異常拋出 
15      * */  
16     public String function(String name) throws Exception{  
17         return name;  
18     }  
19 }///:~  

稍微解釋一下：

以//: 開始，以///:~結束。

@author  作者名

@version 版本號

@since 指明需要最早使用的jdk版本

@param 參數名

@return 返回值情況

@throws 異常拋出情況

 

idea生成HTML文檔的方法：

第一步：

第二步：

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

2. 文檔輸出路徑

3. Locale 選擇地區，這個決定了文檔的語言，中文就是zh_CN

4. 傳入JavaDoc的參數，一般這樣寫 -encoding UTF-8 -charset UTF-8 -windowtitle "文檔HTML頁面標簽的標題" -link http://docs.Oracle.com/javase/7/docs/api