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的幾個文章

除了使用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源文件包)


免責聲明!

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



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