Bootstrap

mac idea配置类和方法的注释

1.配置类的注释

1.1 修改位置

方法一:快捷键打开

command+,

方法二:路径打开

Preference->Editor->File and Code Templates->Files

打开之如下图所示:

1.2 修改class或者interface注释格式

/**
 * 功能描述: ${description}
 * @author ${USER}
 * @date ${DATE} ${TIME}
 */

1.3验证

新建类进行验证:

2.配置方法的注释

2.1 修改位置

方法一:快捷键打开

command+,

方法二:路径打开

Preference->Editor->Live Templates

2.2 修改方法的注释

2.2.1 添加Template Group
2.2.2 在自定义的Template Group下添加Live Template
2.2.3 Live Template的参考值和设置

1)Abbreviation:* (会覆盖idea默认的自动生成多行操作)

可以自定义,类避免默认操作被覆盖, 例如method-comment 。

2)expand with:选择Enter

2.2.4 Template Text格式
*
$param$
 * @return $return$
 * @Description $description$
 * @Author $userName$
 * @Date $date$ $time$
 **/
2.2.5 Edit variables 参数表达式

1)param:

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\b' : '')}; return result", methodParameters())

2)return:methodReturnType()

3)description: description()

4)date: date()

5)time: time()

2.2.6 验证