1.類頭接口頭部註釋
選擇File–>Settings–>Editor–>File and Code Templates–>Includes–>File Header.
註釋模板如下:
/**
* All rights Reserved, Designed By www.XXXX.com
* @projectName ${PROJECT_NAME}
* @title ${NAME}
* @package ${PACKAGE_NAME}
* @description ${TODO}
* @author 韓武洽
* @date ${DATE} ${TIME}
* @version V1.0.0
* @copyright ${YEAR} www.XXXXX.com
* 注意 本內容僅限於 XXXXX科技有限公司,禁止外泄以及用於其他的商業
*/
配置方法包括如下:
2. 方法註釋
IDEA還沒有智能到自動爲我們創建方法註釋,這就是要我們手動爲方法添加註釋,使用Eclipse時我們生成註釋的習慣是
/**+Enter,這裏我們也按照這種習慣來設置IDEA的方法註釋
*
* $methodName$
$params$
* @Description 方法描述,必填 <br/>
* @return $return$
* @throw $throw$
* @author 韓武洽
* @createTime $date$ $time$
* @Version V1.0.0
$updateLog$
*/
方法註釋參數:
$return$: methodReturnType()
$params$: groovyScript("def result=''; 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())
$date$: date()
$time$: time()
$methodName$: concat(qualifiedClassName(),".",methodName())
$updateLog$: groovyScript("def result = ' * @Copyright : www.XXXX.com Inc. All rights reserved.' + '\\n'; result += ' * @UpateLog :'+'\\t\\t'+ 'Modifier'+'\\t\\t'+'ModifyTime'+'\\t\\t'+'Reason/Contents' + '\\n'; result += ' * ---------------------------------------------------------' + '\\n *'; return result;")
配置方法如下:
File-->Settings-->Editor-->Live Templates
3. 修改註釋模板(在原先沒有修改註釋title)和第一步配置使用
$updateLog$
*$modifyContent$
*$separator$
*
參數如下:
$updateLog$: groovyScript("def result = ''; result += ' @UpateLog :'+'\\t\\t'+ 'Modifier'+'\\t\\t'+' ModifyTime'+'\\t\\t'+' Reason/Contents' + '\\n'; result += '* ---------------------------------------------------------'; return result;")
*$modifyContent$ : groovyScript("def result = ''; result +=' \\t\\t韓武洽\\t\\t\\t'+\"${_1} \"+\"${_2} \"+'\\t\\t修改內容' ",date(),time())
*$separator$: groovyScript("def result=' ---------------------------------------------------------';return result")
演示如下:
* @UpateLog : Modifier ModifyTime Reason/Contents
* ---------------------------------------------------------
* 韓武洽 2017/12/20 16:10 修改內容
* ---------------------------------------------------------
*
*/
4. 生成修改信息(在已近有修改title下生成)和第一步配置使用
$modifyContent$
*$separator$
*
參數:
$modifyContent$ : groovyScript("def result = ''; result +=' \\t\\t韓武洽\\t\\t\\t'+\"${_1} \"+\"${_2} \"+'\\t\\t修改內容' ",date(),time())
$separator$: groovyScript("def result=' ---------------------------------------------------------';return result")
整體註釋模板演示:
/**
* XXXX.sys.dao.site.SiteMasterDao.findCountrywide
* @param
* @Description 方法描述,必填 <br/>
* @return com.alibaba.fastjson.JSONObject
* @throw
* @author 韓武洽
* @createTime 2017/12/20 15:47
* @Version V1.0.0
* @Copyright www.xxxxxxx.com Inc. All rights reserved.
* @UpateLog Modifier ModifyTime Reason/Contents
* ---------------------------------------------------------
* 韓武洽 2017/12/20 16:10 添加***字段
* ---------------------------------------------------------
* 韓武洽 2017/12/20 16:15 修改方法,添加邏輯判斷
* ---------------------------------------------------------
* 韓武洽 2017/12/20 16:16 修改**bug
* ---------------------------------------------------------
*
*/