IDEA 代码注解规范

目录

1、配置效果：​2、配置方法：

一、类注释

1、显示模板

2、在idea 新建文件设置类注解的两种方式

(1)、new生成-直接设置File Header(description需要自己重新输写)

(2)、new生成-分别设置需要注释的类(description可以在创建的时候直接弹出框输入)

二、方法注释

1、显示模板

2、方法的注释步骤

Step 1 点击“File”-->“Settings”-->“Live Templates”打开如下对话框，点击右边绿色的加号，创建一个自定义的Template Group，命名为MyGroup。如下图所示。

Step 2 选中 MyGroup，点击右边绿色的加号的创建一个自定义的 Live Template，比如class-comment以及method-comment如下图所示。

Step 3 设置注释的内容（注释模板在该模块的最上面)

Step 4 设置模板的变量内容

3、类的自定义注释

三、属性注释

四、特殊注释标记 TODO:

五、代码业务修改：

六、方法内部单行注释

附录一 Edit variables的含义

---

 

1、配置效果：2、配置方法：

 

在自己idea的安装文件下  D:\Users\xxxx\.IdeaIC2018.3\config\templates

复制MyGroup.xml文件粘贴到相应自己对应的目录即可，有问题可以咨询创建者，找个文件直接上传不了，我放在下载资源

 

 

 

对于注释的要求：第一、能够准确反应设计思想和代码逻辑；第二、能够描述业务含 义，使别的程序员能够迅速了解到代码背后的信息。

 

下面主要将几类注释，配置然后自动产生。

 

一、类注释

1、显示模板

/**

* @author ： ${USER}

* @date ：${YEAR}/${MONTH}/${DAY} ${HOUR}:${MINUTE}

* @description : ${description}

* @path : ${PACKAGE_NAME}.${NAME}

* @modifiedBy ：

*/

说明：

description 描述 ： 该方法做什么事情，实现什么功能

 

2、在idea 新建文件设置类注解的两种方式

 

(1)、new生成-直接设置File Header(description需要自己重新输写)

 

(2)、new生成-分别设置需要注释的类(description可以在创建的时候直接弹出框输入)

 

 

 

二、方法注释

 

1、显示模板

 

方法 显示模板

/**

* @author : $USER$

* @date : $date$ $time$

* @description：$description$

$params$

* @return $returns$

* @throws

*/

 

类：显示模板

/**

 * @author ： $USER$

 * @date ：$data$ $time$

 * @description : $description$

 * @path : $PACKAGE_NAME$.$NAME$

 * @modifiedBy ：