1、注释类型
1.1、文档注释类型
以 /** 开始，以 */ 结束，用于对类、类的属性、方法、代码块、常量等的注释。
1.2、C语言注释类型
以 /* 开始，以 */ 结束，用于方法内多行注释。
1.3、单行注释类型
以 // 开头，直到注释写完，用于方法内对变量、主要功能的单行注释。
2、注释原则
> 注释是为了使代码更清楚；
> 注释是为了编程更顺畅；
> 注释要简单明了；
> 先写注释，后编程；
> 既要注释“做什么”，又要注释“为什么这样做”；
3、书写注释需知
注释要保持正确性，不能出现代码与注释不一致的情况而误导读者。
注释不是用来管理代码版本的，如果有代码不要了，直接删除，不要注释掉。
4、文件注释
4.1、注释类型
注释为“文档注释”类型 /** */，多行文档注释。
4.2、强制性条目
> 文件名称；
> 文件所属权；
> 文件生成日期；
> 文件创建人；
> 创建于版本；
4.3、可选性条目
> 文件其他所需说明；
4.4、举例说明
5、类注释
5.1、注释类型
注释为“文档注释”类型 /** */，多行文档注释。
5.2、强制性条目
> 修改记录（修改人、修改时间、修改原因、修改内容）；
> 类说明：类的定义和功能；
> 创建人；
> 类创建日期；
> 接口注释，在满足类注释的基础之上，接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释；
5.3、举例说明
6、类属性、常量注释
6.1、注释类型
注释为“文档注释”类型 /** */，一般以多行文档注释，当属性亿欧有限可选值时可用<br/>进行换行展示。
6.2、举例说明
7、方法注释
7.1、注释类型
注释为“文档注释”类型 /** */，必须以多行文档注释。
7.2、强制性条目
> 方法功能说明；
> 参数说明；
> 返回值说明；
7.3、可省略条目
> 异常信息说明；
> 方法缺陷说明；
7.4、举例说明
8、方法内变量注释
8.1、注释类型
以“单行注释”类型 // 为主，当注释较长时，可使用“C语言注释”类型 /* */。
8.2、注释原则
> 注释必须包含变量意义和功能；
> 如果是泛型，说明泛型意义；
8.3、举例说明
9、方法内代码注释
9.1、注释类型
以“单行注释”类型 // 为主，当注释较长时，可使用“C语言注释”类型 /* */。
9.2、注释原则
> 必须包含代码块实现功能；
> 必要时，说明书写代码块原因；
9.3、举例说明
10、重要代码注释方案
10.1、注释类型
“单行注释”类型 //。
10.2、注释原则
> 必须说明代码块的功能；
> 说明本块代码实现的原则；
> 必要时，说明书写代码块原因；
10.3、注释方法
在几块代码的开头部分加上
// =================================================================// XXXXXXXXXX代码块（开始）// 代码块说明信息// =================================================================
再在几块代码的结尾部分加上
// =================================================================// XXXXXXXXXX代码块（结束）// =================================================================
10.4、举例说明
11、核心代码修改注释方案
11.1、注释类型
“C语言注释”类型 /* */ 和 “单行注释”类型 //。
11.2、注释原则
> 说明修改代码原因；
> 说明以前代码存在问题；
> 记录修改人和修改日期；
11.3、注释方法
以 // ----------------------形式的注释开头和结尾，将注释掉的代码块包起来
代码块用“C语言注释”类型抱起来
说明部分用“单行注释”类型说明
紧接着下边写修改后的代码
11.4、举例说明
参考：北京金网安泰信息技术有限公司 公开规范文档