IDEA为类和方法添加注释

原創

2020-02-21 12:17

类注释

注释模板(也可以网上搜索更多模板)

/**
 * @author： your name
 * @version: 1.0
 * @date： $DATE$ $TIME$
 * @description： 
 */

新建一个类时，自动生成的类注释配置

操作步骤如图

手动配置类注释（已建好的类没有注释，为其添加注释）

操作步骤

1、如图根据弹窗添加一个Group，随意命名：如 MyClass

2、找到刚刚新建的 MyClass 分组，跟随步骤

3、选择添加 Live Templates 后进入如下界面，标号1处Abbreviation为添加类注释时的快捷方法，区别于默认的 /**+Enter ，标号2 为解释说明

4、加入注释模板后，点击标号4，弹出框如下，选择配置即可

5、如下图所示，选择change（若第一次此处为Define）选中Java ，然后按上图中的标号结束。

6、如图在类头部输入 /c 将会有提示，然后按下 Enter 键将添加默认的注释

方法注释

注释模板(也可以网上搜索更多模板)

/**
 * @author: yourName
 * @description: 
$params$
 * @return: $return$
 * @time: $date$ $time$
 */

操作步骤

1、步骤与类注释的添加步骤一样，新进分组，添加Live Templates ，如图加入注释模板

2、点击标号4，进入弹窗配置参数

3、其中 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())

4、此步骤依然不能忘记