目录
- 设置注释文件模板
- 设置模板
设置注释文件模板
Ctrl + Alt + S 打开设置,Editor - File and Code Templates 选择class、interface、enum根据自己需要选择需要添加注释的文件,依次添加如下配置内容
/**
1. @ClassName ${NAME}
2. @Description TODO
3. @Author ${USER}
4. @Date ${DATE} ${TIME
5. @Version 1.0
*/
设置模板
Ctrl + Alt + S 依次点击 Editor - Live Templates ,给里面添加一个组,然后在组下添加两个模板,分别是类注释模板和方法注释模板,具体操作如下:
6. 添加group组,名称自己定义
2. 给刚建的组下添加类注释模板,内容填写 **,如下
- 填写模板内容 template text ,内容如下, 注意开头没有斜杠
**
* @ClassName $NAME$
* @Description TODO
* @Author $USER$
* @Date $DATE$ $TIME$
* @Version 1.0
*/
-
然后点击右侧 Edit Variables按钮,在弹窗中给模板变量赋值,如下
-
以上步骤都完成后记得右侧Expand with选择enter或者default Enter。表示**后回车触发,如下
-
方法注释同上,只是注释变量不同,且方法注释一般是 /*;内容如下:
*
* @Param $param$
* @return $return$
*/
- 变量赋值如下
如此即完成了所有的注释模板配置工作。就可以在代码中体验了。