IDEA一篇看懂：类注释和方法注释和快捷键

进入公司的第一个步骤，确认好编译环境和软件后就是规范代码，在有处理逻辑的代码中，源程序有效注释量必须在20％以上。本文以亚信公司为例，教程一下IDEA注释设置之余，可以参考一下公司生产的规范

生成类注释

类注释写入文件头部，类名上方，以/* 或/** 开始；

在哪里生成：
在新建类时自动添加注释

如何生成：
新建一个类后，自动弹出类注释块

效果举例：

生成类注解模板

IDEA可引入注释模板
打开file->setting->Editor->Filr and CodeTemplates ->Includes->File Header
输入

/**  
 * Copyright: Copyright (c) ${YEAR} Asiainfo
 * 
 * @ClassName: ${PACKAGE_NAME}.${NAME}
 * @Description: 该类的功能描述
 *
 * @version: v1.0.0
 * @author: ${USER}   
 * @date: ${DATE} ${TIME} 
 *
 * Modification History:
 * Date         Author          Version            Description
 *------------------------------------------------------------
 * ${DATE}      ${USER}          v1.0.0               修改原因
*/

生成方法注释

在哪里生成：
方法注释写在方法上发，内部调用及简单方法以//来注释即可

如何生成：
设置的Abbreviation快捷键 + tab键就直接生成了 （我设置的是asf + tab）

效果举例：

生成方法注解模板

打开file->setting->Editor->LiveTemplates

/**   
 * @Function: $package_name$.$enclosing_type$::$enclosing_method$
 * @Description: 该函数的功能描述
 * @params 
 * @author:  $user$ 
 * @date: $date$ $time$ 
 */ 

配置规则

• 在有处理逻辑的代码中，源程序有效注释量必须在20％以上；
• 类属性、成员变量注释写在定义处上面。用//来注释,需要对齐被注释代码。
  示例：
  //客户证件信息
  String cardType = “”;
• 方法中的相关注释，应在其适用位置上发，需要对齐被注释代码，单行用//来注释，多行用/*来注释。
• 注释简明易懂，不要使用带有个人色彩语调相关字眼；
• 涉及开关代码，需要注明相关开关配置的打开/关闭方式