1.背景
很多开发好多时候其实不太会给类添加注释,尤其是已经有的类,上网查询,好多文档错误百出,而且不全
2.正文
2.1新建类添加注释
idea给新建类创建注释有两种方式
先写一个简单的模板
/**
* @description: TODO
* @author ${USER}
* @date ${YEAR}年${MONTH}月${DAY}日
*/
2.1.1模板引用
1.打开setting,按照如下图,找到对应位置
2.新建模板
点击Files旁边的Includes新建模板
3.让类指向模板
让类指向你刚才创建的文件,就可以了
2.1.2直接添加(简单方便)
直接添加的话,很简单,按照如下操作:
2.2已有类添加注释
1.打开setting,按照如下图,找到对应位置
解释:
4-是快捷键,注意快捷键尽量别写/** 避免冲突
5-注释模板,注意写法是:$key$
7-Define选择使用的对象,Java及其里面包含的全部打勾
8-模板里面吧注释信息的取值
保存之后就可以了