1. 程式人生 > >IntelliJ IDEA設定類註釋和方法註釋

IntelliJ IDEA設定類註釋和方法註釋

預設情況下,idea生成javadoc註釋時,類上面使用時內容為空,方法上使用時會生成引數、返回值和丟擲的異常,如果想顯示@author@date等資訊時,則需要自己配置了。

一、類註釋

方法一:建立類時自動生成註釋

1、開啟Preferences-->Editor-->File and Code Templates,右側選擇Filestab頁,找到ClassInterface,可以看到右側模板裡引用了一個File Header.java模板,如下圖:

在這裡插入圖片描述

2、所以我們只需要修改File Header.java裡的內容,對應的ClassInterface等模板內容也會隨著改變。

3、File Header.java是在Includes裡面的,切換到Includes,點選File Header,修改右側模板內容如下:

/**
 * 
 * @author ${USER}
 * @date ${YEAR}-${MONTH}-${DAY} ${TIME}
 *
 */

在這裡插入圖片描述

4、這裡我只是添加了@author和@date,你可以根據自己的需求新增,配置好之後,再新建類時便會自動生成註釋,如下:

在這裡插入圖片描述

方法二:通過Live Templates方式生成

方法一適用於新建檔案,如果類檔案已經建立了好再想加註釋,需要使用Live Templates方式了,設定方法如下:

1、開啟Preferences-->Editor-->Live Templates

,為了方便管理,新建一個分組來管理自己新增的Live Template,如下:

在這裡插入圖片描述

在這裡插入圖片描述

2、選擇剛建立的分組,然後建立Live Template

在這裡插入圖片描述

3、填寫live Template的縮寫名字、描述和內容,注意內容的開頭沒有/,如下:

在這裡插入圖片描述

4、點選Edit variables,給變數關聯表示式

注意:該步驟必須在步驟3之後才會顯示變數。另外,輸入表示式後直接按回車鍵,如果不按回車直接滑鼠點選其他空白處,自定義表示式不會填充進去

**
 * $END$
 * @author $user$
 * @date $date$
 **/

在這裡插入圖片描述

4、此時模板下面會有個警告,點選後面的define,然後勾選Java即可。

在這裡插入圖片描述

5、配置完成後,在類上面輸入/*c,然後按tab鍵,便會自動生成註釋:

在這裡插入圖片描述

6、如果想修改預設的tab鍵,可以在剛才模板配置介面選擇預設的按鍵:

在這裡插入圖片描述

二、方法註釋

方法註釋需要使用live Template來設定,和類註釋的方法二類似,這裡不再詳細每一步,只列出關鍵步驟,方法如下:

1、在上面建立好的sgl分組裡新建live Template,方法註釋使用頻繁,為了保持/**的習慣,這裡直接命名為*,如下:

*
 * $END$
 * @author $user$
 * @date $date$ $param$
 * @return
 **/

在這裡插入圖片描述

2、為變數關聯表示式

在這裡插入圖片描述

其中,param變數比較麻煩,因為引數不固定,需要使用groovyScript來動態顯示,param表示式的內容如下:

groovyScript("if(\"${_1}\".length() == 2) {return '';} else {def result='\\n'; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) {result+=' * @param ' + params[i] + ((i < params.size() - 1) ? '\\n' : '')}; return result}", methodParameters())

直接複製貼上進去按回車即可。

3、配置完成以後,在方法上面輸入/**,然後按tab鍵便自動生成註釋:

在這裡插入圖片描述

注:對於方法上丟擲的異常,還不知道怎麼自動生成,如有哪位童鞋知道方法希望能在評論裡共享一下。