IntelliJ IDEA 類和方法註釋的生成以及Javadoc的簡單使用記錄

 

idea，設置類註釋和，方法註釋的常見的設置方法（不一樣的版本設置方法有所誤差，簡單記錄一些目前本身在使用的方法，）

方法註釋：在keyMap中搜索Fix doc comment ,後點擊右鍵設置一個快捷鍵（本人採用的ALT+M）而後點擊ok，使用時：須要在選中方法後再使用該快捷鍵，便會生成所對應的模板註釋信息；

使用File and code Template 生成類註釋：通常爲建立該類後，則生成所對應的註釋信息：

File--》Setting--》Editor--》File and Code Template--》File Header  

在該指定的File Header 中填寫所要生成的類註釋模板，後續直接建立類時，便會生成該模板

推薦幾個對於使用Template的幾個文章

IntelliJ下使用Code/Live Template加快編碼速度：程序員的工做不是寫程序，而是寫程序解決問題

IntelliJ Live Template進階使用

Intellj Live Template中的預約義函數列表

除了使用File and Code Template 生成對應的註釋模板外，也可使用Live Templates 製做自定義的註釋模板，

Live Template 的使用流程能夠參考下屬連接的 「方法註釋模塊」的介紹：http://blog.csdn.net/u013412790/article/details/52807102（僅供參考）

第三：也可使用idea的插件中心下載 JavaDoc的插件

File--->settings配置中，選擇plugins，再搜索Javadoc便可（參考）

最後再重點簡單記錄一下Javadoc的註釋規範（）

1.Java 文檔

// 註釋一行
/* ...... */ 註釋若干行
/** ...... */ 註釋若干行，並寫入 javadoc 文檔

一般這種註釋的多行寫法以下：

/**
* .........
* .........
*/

javadoc -d 文檔存放目錄 -author -version 源文件名.java
這條命令編譯一個名爲"源文件名.java"的 java 源文件，並將生成的文檔存放在"文檔存放目錄"指定的目錄下，生成的文檔中 index.html 就是文檔的首頁。-author 和 -version 兩個選項能夠省略。

二. 文檔註釋的格式

1. 文檔和文檔註釋的格式化

生成的文檔是 HTML 格式，而這些 HTML 格式的標識符並非 javadoc 加的，而是咱們在寫註釋的時候寫上去的。
好比，須要換行時，不是敲入一個回車符，而是寫入 <br>，若是要分段，就應該在段前寫入 <p>。
文檔註釋的正文並非直接複製到輸出文件 (文檔的 HTML 文件)，而是讀取每一行後，刪掉前導的 * 號及 * 號之前的空格，再輸入到文檔的。如

/**
* This is first line. <br>
***** This is second line. <br>
This is third line.
*/ 


2. 文檔註釋的三部分
先舉例以下

/**
* show 方法的簡述.
* <p>show 方法的詳細說明第一行<br>
* show 方法的詳細說明第二行
* @param b true 表示顯示，false 表示隱藏
* @return 沒有返回值
*/
public void show(boolean b) {
frame.show(b);
}

第一部分是簡述。文檔中，對於屬性和方法都是先有一個列表，而後纔在後面一個一個的詳細的說明 
簡述部分寫在一段文檔註釋的最前面，第一個點號 (.) 以前 (包括點號)。換句話說，就是用第一個點號分隔文檔註釋，以前是簡述，以後是第二部分和第三部分。

第二部分是詳細說明部分。該部分對屬性或者方法進行詳細的說明，在格式上沒有什麼特殊的要求，能夠包含若干個點號。 
* show 方法的簡述.
* <p>show 方法的詳細說明第一行<br>
* show 方法的詳細說明第二行

簡述也在其中。這一點要記住了

第三部分是特殊說明部分。這部分包括版本說明、參數說明、返回值說明等。
* @param b true 表示顯示，false 表示隱藏
* @return 沒有返回值

三. 使用 javadoc 標記
javadoc 標記由"@"及其後所跟的標記類型和專用註釋引用組成
javadoc 標記有以下一些：
@author 標明開發該類模塊的做者 
@version 標明該類模塊的版本 
@see 參考轉向，也就是相關主題 
@param 對方法中某參數的說明 
@return 對方法返回值的說明 
@exception 對方法可能拋出的異常進行說明 

@author 做者名
@version 版本號
其中，@author 能夠屢次使用，以指明多個做者，生成的文檔中每一個做者之間使用逗號 (,) 隔開。@version 也可使用屢次，只有第一次有效

使用 @param、@return 和 @exception 說明方法
這三個標記都是隻用於方法的。@param 描述方法的參數，@return 描述方法的返回值，@exception 描述方法可能拋出的異常。它們的句法以下：
@param 參數名參數說明
@return 返回值說明
@exception 異常類名說明

 

四. javadoc 命令
用法：
　　javadoc [options] [packagenames] [sourcefiles]

選項：

-public 僅顯示 public 類和成員 
-protected 顯示 protected/public 類和成員 (缺省) 
-package 顯示 package/protected/public 類和成員 
-private 顯示全部類和成員 
-d <directory> 輸出文件的目標目錄 
-version 包含 @version 段 
-author 包含 @author 段 
-splitindex 將索引分爲每一個字母對應一個文件 
-windowtitle <text> 文檔的瀏覽器窗口標題 

javadoc 編譯文檔時能夠給定包列表，也能夠給出源程序文件列表。例如在 CLASSPATH 下有兩個包若干類以下：

　　fancy.Editor
　　fancy.Test
　　fancy.editor.ECommand
　　fancy.editor.EDocument
　　fancy.editor.EView

能夠直接編譯類：
javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

也能夠是給出包名做爲編譯參數，如：javadoc fancy fancy.editor
能夠本身看看這兩種方法的區別

到此爲止javadoc就簡單介紹完了，想要用好她仍是要多用，多參考標準java代碼(可參考JDK安裝目錄下的src源文件包)