【操作工具】IDEA创建类及已有类添加注释-详细操作

Myth丶恋晨 2023-10-16 15:37 184阅读 0赞

### **1.背景** ###

很多开发好多时候其实不太会给类添加注释，尤其是已经有的类，上网查询，好多文档错误百出，而且不全

### **2.正文** ###

#### 2.1新建类添加注释 ####

idea给新建类创建注释有两种方式

先写一个简单的模板

/**  
    * @description: TODO
    * @author ${USER}
    * @date ${YEAR}年${MONTH}月${DAY}日
    */

##### **2.1.1模板引用** #####

1.打开setting，按照如下图，找到对应位置

![5729b5108d9a40d1b664e13724cc72bd.png][]

2.新建模板

点击Files旁边的Includes新建模板

![c710371be2004e308e7637ebf2279f3b.png][]

3.让类指向模板

让类指向你刚才创建的文件，就可以了

![4aeb98ef74f141fdbf89bd5cbc1848b9.png][]

##### **2.1.2直接添加(简单方便)** #####

直接添加的话，很简单，按照如下操作：

![92a02a4f905249b0b240034f3c787e1b.png][]

#### **2.2已有类添加注释** ####

1.打开setting，按照如下图，找到对应位置

![c575bd47c8a341008d7ca079bd53ef4c.png][]

解释：

4-是快捷键，注意快捷键尽量别写/\*\* 避免冲突

5-注释模板，注意写法是：$key$

7-Define选择使用的对象，Java及其里面包含的全部打勾

![ac72fca6a1eb499790f9d343b7439f96.png][]

8-模板里面吧注释信息的取值

![728c7fc1d53c4e8796e12921d7f9c5d4.png][]

保存之后就可以了

[5729b5108d9a40d1b664e13724cc72bd.png]: https://img-blog.csdnimg.cn/5729b5108d9a40d1b664e13724cc72bd.png
[c710371be2004e308e7637ebf2279f3b.png]: https://img-blog.csdnimg.cn/c710371be2004e308e7637ebf2279f3b.png
[4aeb98ef74f141fdbf89bd5cbc1848b9.png]: https://img-blog.csdnimg.cn/4aeb98ef74f141fdbf89bd5cbc1848b9.png
[92a02a4f905249b0b240034f3c787e1b.png]: https://img-blog.csdnimg.cn/92a02a4f905249b0b240034f3c787e1b.png
[c575bd47c8a341008d7ca079bd53ef4c.png]: https://img-blog.csdnimg.cn/c575bd47c8a341008d7ca079bd53ef4c.png
[ac72fca6a1eb499790f9d343b7439f96.png]: https://img-blog.csdnimg.cn/ac72fca6a1eb499790f9d343b7439f96.png
[728c7fc1d53c4e8796e12921d7f9c5d4.png]: https://img-blog.csdnimg.cn/728c7fc1d53c4e8796e12921d7f9c5d4.png