一、概述

IDEA自帶的注釋模板一般都很簡單，然而我們在寫代碼的時候喜歡把類注釋和文檔注釋寫在代碼里，既方便自己看所有的參數，也便于以后維護代碼的時候看到編碼作者。下面是我的代碼注釋，我們就按照這種格式來設置：

類注釋模板：

方法注釋模板：

二、類注釋模板

1、File-->settings-->Editor-->File and Code Templates-->Files

（1）@BelongsProject：當前項目的名稱

（2）@BelongsPackage：當前包的名稱

（3）@Author：作者姓名（可以寫死，寫成你的名字）

（4）@CreateTime：該類創(chuàng)建的時間

（5）@Description：對該類的描述（該類的功能）

（6）@Version：設置版本號，一般新創(chuàng)建的類都是1.0版本，這里寫死就可以了

/**
*@BelongsProject: ${PROJECT_NAME}
*@BelongsPackage: ${PACKAGE_NAME}
*@Author: yanhongwei
*@CreateTime: ${YEAR}-${MONTH}-${DAY}  ${HOUR}:${MINUTE}
*@Description: TODO
*@Version: 1.0
*/

三、方法注釋模板

1、創(chuàng)建模板 

IDEA還沒有智能到自動為我們創(chuàng)建方法注釋，這就是要我們手動為方法添加注釋，我們的習慣是 /**+Enter，這里我們也按照這種習慣來設置IDEA的方法注釋

1、File-->Settings-->Editor-->Live Templates

 （1）新建組：命名為userDefine

（2）新建模板：選中你剛才創(chuàng)建的組，然后右上角新建模板，命名為* 

        因為IDEA生成注釋的默認方式是：/*+模板名+快捷鍵（比如若設置模板名為add快捷鍵用Tab，則生成方式為： /*add+Tab），如果不采用這樣的生成方式IDEA中沒有內容的方法將不可用，例如獲取方法參數的methodParameters(）、獲取方法返回值的methodReturnType(）

2、設置模板內容-IDEA格式模板

 注意第一行，只有一個*而不是/*

在設置參數名時必須用${參數名}$的方式，否則第五步中讀取不到你設置的參數名

注意：下面這段是代碼，可以直接復制的！可以直接復制的！可以直接復制的！不要再問我為什么都是圖片了，留著眼睛干啥？

*
 * @description:
 * @author: yanhongwei 
 * @date: $date$ $time$
 * @param: $param$
 * @return: $return$
 **/

3、設置模板應用場景

點擊模板頁面最下方的警告，來設置將模板應用于那些場景，一般選擇EveryWhere-->Java即可

（如果曾經修改過，則顯示為change而不是define）

4、設置參數

把右側的Expand with：改為Enter ；然后選擇右側的Edit variables按鈕

PS:第4步和第5步順序不可顛倒，否則第5步將獲取不到方法

 1、IDEA格式的模板只需要為每個參數選擇對應的方法即可

 2、設置成功后點擊OK，返回項目新建一個方法，寫完入參和返回值以后，在方法上面：

         敲出：/** 回車

5、JavaDoc格式

 該格式和IDEA格式略有不同：（@param      @return）

（1）返回上面第二步中的格式設置：輸入下面代碼（注意格式）

*
 * @description:
 * @author: yanhongwei 
 * @date: $date$ $time$ $param$ $return$
 **/

（2）參數設置（JavaDoc格式的需要自定義參數以及返回值的實現方式）

獲取參數實現方式：

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

返回值實現方式：

groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return: ' + \"${_1}\"", methodReturnType())

如果返回值不想有報名，可以使用下面這個參數： 

groovyScript("def result=''; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split('<').toList(); for(i = 0; i < params.size(); i++) {if(i!=0){result+='<';};  def p1=params[i].split(',').toList();  for(i2 = 0; i2 < p1.size(); i2++) { def p2=p1[i2].split('\\\\.').toList();  result+=p2[p2.size()-1]; if(i2!=p1.size()-1){result+=','}  } ;  };  return result", methodReturnType())

  （3）設置成功后點擊OK，返回項目新建一個方法，寫完入參和返回值以后，在方法上面：

         敲出：/** 回車

        然后會顯示：（注意不一樣的地方）

 大家可以根據自己的愛好和風格去設置?。?！

總結

到此這篇關于IDEA類與方法注釋模板設置的文章就介紹到這了,更多相關IDEA類與方法注釋模板設置內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論