Java注释

一、布景

　　1、当我们第一次接触某段代码，但又被要求在极短的时刻内有用地剖析这段代码，我们需要什么样的注释信息？

　　2、怎么样避免我们的注释冗长而且凌乱不胜呢？

　　3、在多人协同开发、维护的今天，我们需要怎么样的注释来保证高质、高交的进行开发和维护工作呢？

　　二、意义

　　规范中的注释是规范设计者与规范阅读者之间通信的主要手段。应用注释规范对于软件自己和软件开发人员而言尤为主要。而且在风行的火速开发思惟中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的削减一个软件的维护成本 , 而且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护。好的注释规范可以改善软件的可读性，可以使发人员尽快而彻底地了解新的代码。好的注释规范可以最大限度的提高团队开发的合作效率。持久的规范性编码还可以闪开发人员养成精采的编码习惯，甚至磨炼出加倍严谨的思维能力。

　　三、注释的原则

　　1、 注释形式统一

　　在整个应用规范中，使用具有一致的标点和结构的样式来构造注释。如果其他项目组发现他们的注释规范与这份文档不同，按照他们的规范写代码，不要试图在既成的规范系统中引入新的规范。

　　2、 注释的精练

　　内容要简单、了然、寄义切确，防止注释的多义性，错误的注释不单无益反而有害。

　　3、 注释的一致性

　　在写代码之前或者边写代码边写注释，因为往后很可能没有时刻来这样做。此外，如果有机会复查已编写的代码，在今天看来较明显的东西六周以后或许就不明显了。凡是描述性注释先于代码建树，解释性注释在开发过程中建树，提示性注释在代码完成之后建树。修改代码的同时修改相应的注释，以保证代码与注释的同步。

　　4、 注释的位置

　　保证注释与其描述的代码相邻，即注释的就近原则。对代码的注释应放在其上方相邻或右方的位置，不可放在下方。避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情形下，将所有行尾注释要对齐。

　　5、 注释的数目

　　注释必不成少，但也不应过多，在现实的代码规范中，要求注释占轨范代码的比例达到20%左右。注释是对代码的“提示”，而不是文档，规范中的注释不能喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少。不要被动的为写注释而写注释。

　　6、删除无用注释

　　在代码交付或部署发布之前，必需删掉临时的或无用的注释，以避免在日后的维护工作中产生混乱。

　　7、 复杂的注释

　　如果需要用注释来诠释复杂的代码，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单便于使用而牺牲机能，但必需保持性能和可维护性之间的平衡。

　　8、 多余的注释

　　描述规范功能和规范各组成部门彼此关系的高级注释是最有用的，而逐行解释程序如何工作的初级注释则不利于读、写和修改，是不必要的，也是难以维护的。避免每行代码都使用注释。如果代码原本就是清楚、一目了然的则不加注释，避免多余的或不恰当的注释呈现。

　　9、必加的注释

　　典型算法必需有注释。在代码不明晰或不成移植处必需有注释。在代码修改处加上修改标识的注释。在循环和逻辑分支组成的代码中添加注释。为了防止问题一再出现，对错误修复和解决方法的代码使用注释，尤其是在团队情形中。

　　10、注释在编译代码时会被忽略，不编译到最后的可执行文件中，所以注释不会增加可执行文件的大小。

　　四、JAVA注释技巧

　　1、空行和空白字符也是一种特殊注释。操作缩进和空行，使代码与注释轻易区

　　别，并协调美观。

　　2、当代码比较长，特别是有多重嵌套时，为了使条理清楚，理当在一些段落的

　　结尾处加注释（在闭合的右花括号后注释该闭合所对应的起点），注释不能

　　写得很长，只要能表示是哪个控制语句控制的范围结束即可，这样便于阅读。

　　3、将注释与注释分隔符用一个空格分隔，在没有颜色提醒的情形下查看注释时，

　　这样做会使注释很明显并且轻易被找到。

　　4、不能给块注释的四周加上外框。这样看起来可能很漂亮，可是难于维护。

　　5、每行注释（连同代码）不要超过120个字(1024×768)，最好不要超过80

　　字(800×600) 。

　　6、Java编辑器（IDE）注释快捷键。Ctrl+/ 注释当前行,再按则取消注释。

　　7、对于多行代码的注释，尽量不采用“/*......*/”，而采用多行“//”注释，

　　这样虽然麻烦，可是在做屏蔽调试时不用查找配对“/*......*/”。

　　8、注释作为代码切换开关，用于临时测试时屏蔽某些代码。

　　例一：

　　//*/

　　codeSegement1;

　　//*/

　　改动第一行就成了：

　　/*/

　　codeSegement1;

　　//*/

　　例二：

　　//----------------------第一段有用，第二段被注释

　　//*/

　　codeSegement1;

　　/*/

　　codeSegement2;

　　//*/

　　只需删除第一行的/就可以酿成：

　　//----------------------第一段被注释，第二段有用

　　/*/

　　codeSegement1;

　　/*/

　　codeSegement2;

　　//*/

1、源文件注释 
源文件注释采用 /** …… */，在每个源文件的头部要有必要的注释信息，包括：文件名；文件编号；版本号；作者；创建时间；文件描述包括本文件历史修改记录等。中文注释模版：

 

Java代码  

1. /**  
2. * 文 件 名 :  
3.     * CopyRright (c) 2008-xxxx:  
4. * 文件编号：  
5. * 创 建 人：  
6. * 日    期：  
7. * 修 改 人：  
8. * 日   期：  
9. * 描   述：  
10. * 版 本 号：  
11. */   

 

2、类（模块）注释： 
类（模块）注释采用 /** …… */，在每个类（模块）的头部要有必要的注释信息，包括：工程名；类（模块）编号；命名空间；类可以运行的JDK版本；版本号；作者；创建时间；类（模块）功能描述（如功能、主要算法、内部各部分之间的关系、该类与其类的关系等，必要时还要有一些如特别的软硬件要求等说明）；主要函数或过程清单及本类（模块）历史修改记录等。 
英文注释模版：

 

Java代码  

1. /**  
2. * CopyRright (c)2008-xxxx:   <展望软件Forsoft >                           
3.     * Project:                     <项目工程名 >                                           
4. * Module ID:   <(模块)类编号，可以引用系统设计中的类编号>     
5.     * Comments:  <对此类的描述，可以引用系统设计中的描述>                                            
6. * JDK version used:      <JDK1.6>                               
7. * Namespace:           <命名空间>                               
8. * Author：        <作者中文名或拼音缩写>                  
9. * Create Date：  <创建日期，格式:YYYY-MM-DD>  
10. * Modified By：   <修改人中文名或拼音缩写>                                          
11. * Modified Date:  <修改日期，格式:YYYY-MM-DD>                                     
12.     * Why & What is modified  <修改原因描述>     
13. * Version:                  <版本号>                        
14. */   

 

如果模块只进行部分少量代码的修改时，则每次修改须添加以下注释：

 

Java代码  

1. //Rewriter   
2. //Rewrite Date：<修改日期:格式YYYY-MM-DD> Start1：   
3. /* 原代码内容*/   
4. //End1：   
5. 将原代码内容注释掉，然后添加新代码使用以下注释：   
6. //Added by   
7. //Add date：<添加日期，格式：YYYY-MM-DD> Start2：   
8. //End2：   
9. 如果模块输入输出参数或功能结构有较大修改，则每次修改必须添加以下   
10. 注释：   
11. //Log ID：<Log编号,从1开始一次增加>   
12. //Depiction：<对此修改的描述>   
13. //Writer：修改者中文名   
14. //Rewrite Date：<模块修改日期，格式：YYYY-MM-DD>   

 

3、接口注释： 
接口注释采用 /** …… */，在满足类注释的基础之上，接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用，块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

 

4、构造函数注释： 
构造函数注释采用 /** …… */，描述部分注明构造函数的作用，不一定有块标记部分。 
注释模版一：

 

Java代码  

1. /**  
2. * 默认构造函数  
3. */   
4. 注释模版二：   
5. /**  
6. * Description :       带参数构造函数,  
7. *                       初始化模式名,名称和数据源类型  
8. * @param schema：   模式名  
9. * @param name：   名称  
10. * @param type： 数据源类型  
11. */   

 

5、函数注释： 
函数注释采用 /** ……*/，在每个函数或者过程的前面要有必要的注释信息，包括：函数或过程名称；功能描述；输入、输出及返回值说明；调用关系及被调用关系说明等。函数注释里面可以不出现版本号（@version）。 
注释模版一：

 

Java代码  

1. /**  
2.   * 函 数 名 :  
3.   * 功能描述：  
4. * 输入参数:     <按照参数定义顺序>  
5. *             <@param后面空格后跟着参数的变量名字  
6. *            （不是类型），空格后跟着对该参数的描述。>  
7. *  
8. * 返 回 值:  - 类型 <说明>  
9. *            <返回为空（void）的构造函数或者函数，  
10. *            @return可以省略; 如果返回值就是输入参数，必须 *            用与输入参数的@param相同的描述信息; 必要的时*            候注明特殊条件写的返回值。>  
11. * 异    常：<按照异常名字的字母顺序>  
12. * 创 建 人:  
13. * 日    期:  
14. * 修 改 人:  
15. * 日    期:  
16. */   

 

注释模版二：

 

Java代码  

1. /**  
2. * FunName:           getFirstSpell  
3.   * Description :      获取汉字拼音首字母的字符串，  
4. *                   被生成百家姓函数调用  
5.   * @param：         str the String是包含汉字的字符串  
6.   * @return String：汉字返回拼音首字母字符串；  
7. *                  英文字母返回对应的大写字母；  
8. *                 其他非简体汉字返回 '0'；  
9. * @Author:       ghc  
10. * @Create Date: 2008-07-02  
11. */   

 

6、方法注释： 
方法注释采用 /** …… */，对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索。

 

7、方法内部注释： 
控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出详细的注释。 
    
8、 全局变量注释： 
要有较详细的注释，包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。

 

9、局部（中间）变量注释： 
主要变量必须有注释，无特别意义的情况下可以不加注释。

 

10、实参/参数注释： 
参数含义、及其它任何约束或前提条件。

 

11、字段/属性注释： 字段描述，属性说明。

 

12、常量：常量通常具有一定的实际意义，要定义相应说明。