一、概述

IDEA自帶的注釋模板一般都很簡(jiǎn)單，然而我們?cè)趯?xiě)代碼的時(shí)候喜歡把類(lèi)注釋和文檔注釋寫(xiě)在代碼里，既方便自己看所有的參數(shù)，也便于以后維護(hù)代碼的時(shí)候看到編碼作者。下面是我的代碼注釋?zhuān)覀兙桶凑者@種格式來(lái)設(shè)置：

類(lèi)注釋模板：

方法注釋模板：

二、類(lèi)注釋模板

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

（1）@BelongsProject：當(dāng)前項(xiàng)目的名稱(chēng)

（2）@BelongsPackage：當(dāng)前包的名稱(chēng)

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

（4）@CreateTime：該類(lèi)創(chuàng)建的時(shí)間

（5）@Description：對(duì)該類(lèi)的描述（該類(lèi)的功能）

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

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

三、方法注釋模板

1、創(chuàng)建模板 

IDEA還沒(méi)有智能到自動(dòng)為我們創(chuàng)建方法注釋?zhuān)@就是要我們手動(dòng)為方法添加注釋?zhuān)覀兊牧?xí)慣是 /**+Enter，這里我們也按照這種習(xí)慣來(lái)設(shè)置IDEA的方法注釋

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

 （1）新建組：命名為userDefine

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

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

2、設(shè)置模板內(nèi)容-IDEA格式模板

 注意第一行，只有一個(gè)*而不是/*

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

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

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

3、設(shè)置模板應(yīng)用場(chǎng)景

點(diǎn)擊模板頁(yè)面最下方的警告，來(lái)設(shè)置將模板應(yīng)用于那些場(chǎng)景，一般選擇EveryWhere-->Java即可

（如果曾經(jīng)修改過(guò)，則顯示為change而不是define）

4、設(shè)置參數(shù)

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

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

 1、IDEA格式的模板只需要為每個(gè)參數(shù)選擇對(duì)應(yīng)的方法即可

 2、設(shè)置成功后點(diǎn)擊OK，返回項(xiàng)目新建一個(gè)方法，寫(xiě)完入?yún)⒑头祷刂狄院?，在方法上面?/p>

         敲出：/** 回車(chē)

5、JavaDoc格式

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

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

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

（2）參數(shù)設(shè)置（JavaDoc格式的需要自定義參數(shù)以及返回值的實(shí)現(xiàn)方式）

獲取參數(shù)實(shí)現(xiàn)方式：

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())

返回值實(shí)現(xiàn)方式：

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

如果返回值不想有報(bào)名，可以使用下面這個(gè)參數(shù)： 

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）設(shè)置成功后點(diǎn)擊OK，返回項(xiàng)目新建一個(gè)方法，寫(xiě)完入?yún)⒑头祷刂狄院?，在方法上面?/p>

         敲出：/** 回車(chē)

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

 大家可以根據(jù)自己的愛(ài)好和風(fēng)格去設(shè)置?。?！

總結(jié)

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

最新評(píng)論