Java使用IDEA自定义文档注释模板

目录

1.类中的注释

2.方法中的注释

1.新建模板

 2.自定义名字

3.创建模板

4.选择范围：

 5.编辑变量

6.设置快捷键

7.点击OK完成设置。 

 3.测试

类的注释测试：

 方法的注释测试：

---

1.类中的注释

File-->Settings-->Editor-->File and Code Templates-->Includes

/**
 *@BelongsProject: ${PROJECT_NAME}  
 *@BelongsPackage: ${PACKAGE_NAME}  
 *@Author: ChenLan                  
 *@Date: ${DATE} ${TIME}           
 *@Description:              
 */

具体解释可以看这个：

 

2.方法中的注释

注意，这个一定要按照步骤一步一步来。

1.新建模板

File-->Settings-->Editor--> Live Templates

点击右边的”+“号,选择Template Group

 

 2.自定义名字

 

3.创建模板

1.Abbreviation：那里不要用 ‘/’ 开头的！！！ 模板中开头不要 / ，我是用‘*’，你随意

2.描述：随意即可，中文英文都行

3.模板内容：具体可以百度，我的是这样的

注意：开头不需要有‘/’，是以‘*’打头的

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

4.选择范围：

可以只选择Java，勾一下即可；也可以选择全部范围。

 5.编辑变量

如图所示

params和return一定要在下面。其中params和return都是设置在 Default value 。

params内容为：

groovyScript("if(\"${_1}\".length() == 2)  {return '';}  else {def result='';   def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]','').split(',').toList();  for(i = 0; i < params.size(); i++)   {  if(i==0){  result+='* @Param ' + params[i] + ': '  }  else{  result+='\\n' + ' * @Param ' + params[i] + ': '}  };   return result;}", methodParameters());  

return内容为：

groovyScript("def returnType = \"${_1}\"; def result = '* @return: ' + returnType; return result;", methodReturnType()); 

 

6.设置快捷键

我选的enter，到时候在需要文档注释的地方输入‘/*’+‘enter’键，就可以自动添加注释。

7.点击OK完成设置。 

全部完成后，界面为：

 

 3.测试

类的注释测试：

新建一个类，Test，之后会要求填写使用者，这个随意，和代码是无关的。

可以看到，添加成功。这个是会自动添加的。 

 

 

 方法的注释测试：

输入‘/*’，然后enter

结果如下：

 

 如果带参数的方法的话

 

参考文献：

IDEA自定义注释模板（主要解决params和return的问题）_TheBiiigBlue的博客-CSDN博客

Intellij IDEA设置默认文档注释 - 知乎

IDEA创建类模板和方法模板（超详细）_sdut菜鸟的博客-CSDN博客_idea 模板 

Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的 实测有效_蜀山雪松的博客-CSDN博客_idea方法注释模板return