在idea中为类和方法自动生成注释

一、设置类级别的注释(创建类是自动生成注释)
二、设置方法级别的注释

一、设置类级别的注释(创建类是自动生成注释)

图中的代码块:

/**
* @author ${USER}
* @date ${DATE} ${TIME}
*/

/**
* @author sjl
* @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
*/

上述8个变量说明:

$ {USER}：当前系统登录的用户名，如果你的系统用户名是windows默认的Adminstrator，千万别用，鬼知道你的同事里有多少人也是Administrator

${DATE}：当前系统设置的日期格式，作为一个有强迫症的程序员，不能接受同一项目的注释里有超过一种的日期格式

${TIME}：当前系统设置的时间格式，作为一个有强迫症的程序员，不能接受同一项目的注释里有超过一种的时间格式

${YEAR}：完整的年份，比如 2018

${MONTH}：完整的月份，比如 01

${DAY}：完整的日期，比如 17

${HOUR}：24小时制的小时，比如 16

${MINUTE}：完整的分钟，比如 52

二、设置方法级别的注释

如图，创建一个新的group。
然后在添加模板。
编辑模板。

步骤说明:

1是设置的快捷键，我这里设置的三个星号。
2是模板代码块
```
**
* @description $description$
$params$  //也可以将此行改为   * @params $params$
* @return  $return$
* @author  SJl
* @date  $date$ $time$
*
*/
```
注意这里的代码块前面是没有/的，在方法外敲/+***+Enter就能生成注释，如果你写成/**开头的话在方法外敲是不能获取return和params参数的，只有在方法内敲才能获取到。
3是选择生效区域，点击define，选择everyWhere 或者 java。

4是参数设置。

2的模板代码块如果你写的是* @params $params$，参数设置请选择 methodParameters()，如果你写的是 $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())

5是选择按键，默认的是Tab，我一般选Enter。

两种不同的显示效果。

参考链接

转载于:https://www.cnblogs.com/StoneGate/p/9378088.html

在idea中为类和方法自动生成注释相关推荐

在 idea 中为类和方法自动生成注释
前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家.点击跳转到教程. 项目规范中有一项常见的要求,在类级和方法级注释里写上创建者和创建时间,在方法级注释里写上创建者和维护 ...
IDEA类和方法自动添加注释
给类自动添加注释信息给方法自动添加注释信息给类自动加上注释第一步点击File里的Settings先到设置里面去第二步,在Settings里面按照下图顺序找到设置界面,右边即为设置界面第三步, ...
idea里边创建类的时候和方法自动生成注释
我们经常写代码的时候需要在类上编写注释,标明这个类是谁写的有什么作用,其实每次写都会发现有很多相同的字段,比如作者,创建时间,类名等,有的时候方法上也要标明方法的返回值,参数等信息,在idea里边我们 ...
eclipse 中get set方法自动生成注释
1.一般我们用eclipse做开发时,不可避免的需要创建新的javabean,此时我们在设定get与set方法一般都是用eclipse自带的生成工具,但是这样生成的get与set方法是没有注释,如此还 ...
java 类和方法自动添加注释
设置文件头File Header 路径为 setting-->editor-->File and Code Templates-->Includes-->File Header ...
java域的控制修饰符可分为_Java中的类和方法的修饰符
java 中的类和方法的修饰符Java程序在定义类时,除了使用class关键字标识之外,还可以在class之前增加若干类的修饰符来修饰限定所定义的类的特性.类的修饰符分为访问控制符和非访问控制符两大类 ...
@data 重写set方法_C#中的类、方法和属性
这节讲C#中的类,方法,属性.这是面向对象编程中,我们最直接打交道的三个结构. 类: 类(class)是面向对象中最基本的单元,它是一种抽象,对现实世界中事物的抽象,在C#中使用class关键字 ...
C# 子类实例化基类基类使用不了子类的方法_C#中的类、方法和属性
这节讲C#中的类,方法,属性.这是面向对象编程中,我们最直接打交道的三个结构. 类: 类(class)是面向对象中最基本的单元,它是一种抽象,对现实世界中事物的抽象,在C#中使用class关键字 ...
php5中魔术方法函数有哪几个,php中的类魔术方法有哪些
php中的类魔术方法有:1.__sleep,返回一个包含对象中所有应被序列化的变量名称的数组:2.__tostring,返回一个类被当作字符串时要输出的内容:3.__construct,构造方法:4. ...

在idea中为类和方法自动生成注释

一、设置类级别的注释(创建类是自动生成注释)

二、设置方法级别的注释

在idea中为类和方法自动生成注释相关推荐

最新文章

热门文章