转自：

作者：objcat
链接：https://www.jianshu.com/p/812d06702437

一.文件注释

创建文件后, 编译器会在类名前面生成固定的注释, 来丰富代码的可读性, 在阿里巴巴Java开发手册里也明确写到所有的类都必须添加创建者和创建日期.

/*** description: ${NAME} <br>* date: ${DATE} ${TIME} <br>* author: ${USER} <br>* version: 1.0 <br>*/

我们来看一下效果吧

其中以$开头的都是IDE中的内置变量, 我们把它引用过来, 也可以自定义成常量.

二.方法注释

写方法的时候也要带上相应的注释, 这样可以增加方法的可读性, 下面我们就来添加一个自定义注释模板, 方法注释的配置要比文件注释复杂一些

1.创建一个group名字随便起

2.选中group并新建一个模板

3.选择模板类型

勾选java

4.填写模板内容

** description: $description$ <br>* version: 1.0 <br>* date: $date$ $time$ <br>* author: objcat <br>*
$params$* @return $return$*/

注意上述文字一定要一个字不差的填写, 我的模板并没有写歪, 而是必须要这么写才能正常使用, 关键字需要用*, 不要改动.

添加快捷键与注释

Abbreviation 关键字
Description 模板说明

5.关联变量

点击关联按钮

按照图中的方式去关联变量

变量不用手打, 可以下拉选择

另外不想自己选的可以直接复制进去
注意第三个参数是一个groovy脚本目的是把参数罗列出来

methodName()
date()
time()
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())
methodReturnType()

这里说一下为什么要关联变量你应该可以发现在模板中有
$date$ $time$ $params$ $return$ 这些用$符号包括的代码这些都是自定义变量, 而我想在写注释的时候实时获取这些, 比如时间, 日期, 参数名, 返回值类型 所以需要关联编译器的变量自动填入.

到了这一步设置都结束了

使用方法只需要打 /** + tab 就可以了

好的我们来看一看效果吧

我们来生成一个javadoc看看效果
Tools -> Generate JavaDoc

如果出现编码问题请如图填入下面这句话(屏幕一大堆问号)

-charset utf-8 -encoding utf-8

finally enjoy it

idea 设置注释模板相关推荐

goland 方法注释_goland 设置注释模板的过程图文详解
网上找了一些办法都没有说到关键点: 梳理一下设置步骤如下,以及避免的坑. 新建文件自动加注释: Preferences | Editor | File and Code Templates 打开go ...
IDEA个性化设置注释模板(详细版)
IDEA设置注释模板类注释模板方法注释模板效果展示 1. 类注释模板类注释模板是IDEA创建类时生成的注释第一步.File -> Settings 第二步.Editor -> F ...
IDEA中设置注释模板的方法
IDEA中设置注释模板的方法 https://www.cnblogs.com/pcheng/p/10121683.html https://blog.csdn.net/zlbdmm/article/d ...
IDEA中设置注释模板
IDEA中设置注释模板主要分为两个部分,分别是创建java文件时类的注释和方法的注释. 这里为大家详细介绍一下方法,大家可以根据自己的习惯生成自己喜欢的注释模板.效果如下: 一.设置类的注释模板 1. ...
快捷键Java模板注释_eclipse 设置注释模板＆调出注释快捷键
1,设置注释模板点击Windows(窗口)->Preferences(首选项)->Java->Code Style(代码样式)->Code Templates(代码模板) 然 ...
android studio中如何设置注释模板
在开发程序的时候,我们一般都会给文件自动添加上一些关于文件的注释信息,比如开发者的名字,开发的时间,开发者的联系方式等等.那么在android studio中该如何设置呢? 工具/原料 android ...
idea如何设置注释模板，图文超详细讲解
目录先打开idea设置一,idea类注释 1,找到以下设置 2,设置模板 3,apply保存完成二,idea方法注释 1,创建自定义的组 2,创建模板 3,设置模板 4,选择生成模板的文件 5, ...
IDEA 设置注释模板顺序
配置注释模板Live Templates时,模板展示顺序只会按照首字母顺序进行排序,若想按照自己配置的模板进行排序,可按照下图关闭设置即可.
IDEA设置注释模板——类模板和方法模板(参数，返回值)
一.类的注释模板文件------设置-------------编辑器-------文件和代码模板模板: /*** ----------------------------------------- ...

idea 设置注释模板

转自：

一.文件注释

二.方法注释

finally enjoy it

idea 设置注释模板相关推荐

最新文章

热门文章