程序注释相关事项

写程序一定要养成良好的习惯，除了代码风格外，注释也十分重要。
下面贴出两个重要的注释类型。想当年写C++课程大作业一千多行代码看得七荤八素，现在看别人开源网站源码却十分轻松，中间差的就是注释啊，好的注释确实十分重要啊。

程序头注释

用于对一个较大模块的综合概述：

/*********************************************************************************
  *Copyright(C),2010-2011,Your Company
  *FileName:  // 文件名
  *Author:  //作者
  *Version:  //版本
  *Date:  //完成日期
  *Description:  //用于主要说明此程序文件完成的主要功能
                //与其他模块或函数的接口、输出值、取值范围、
                //含义及参数间的控制、顺序、独立及依赖关系
  *Others:  //其他内容说明
  *Function List:  //主要函数列表，每条记录应包含函数名及功能简要说明
     1.…………
     2.…………
  *History:  //修改历史记录列表，每条修改记录应包含修改日期、修改者及修改内容简介
     1.Date:
       Author:
       Modification:
     2.…………
**********************************************************************************/

函数头注释

另一种就是函数头注释，通常在函数模块中有很多，方便人直观地理解函数：

/*Function name: //这个Function name会不会有点多余。 
 *Description: 
 *Input :      
 *Return Value: 
 *Revision Date: 2011/05/16
 */

全局变量注释

再有就是全局变量一定要注释，不然别人接手一脸懵逼的（随便贴一段）：

public final class String

   implements Java.io.Serializable, Comparable<String>,CharSequence

{
   /** The value is used for characterstorage. */
   private final char value[];
   /** The offset is the first index of thestorage that is used. */
   private final int offset;
   /** The count is the number of charactersin the String. */

   private final int count;
   /** Cache the hash code for the string */

   private int hash; // Default to 0

……
}

字段/属性注释

还有，声明一个class或者struct什么的，字段/属性的注释，让人一目了然：

public class EmailBody implements Serializable{

   private String id;

   private String senderName;//发送人姓名

   private String title;//不能超过120个中文字符

   private String content;//邮件正文

   private String attach;//附件，如果有的话

   private String totalCount;//总发送人数

   private String successCount;//成功发送的人数

   private Integer isDelete;//0不删除 1删除

   private Date createTime;//目前不支持定时 所以创建后即刻发送

   privateSet<EmailList> EmailList;

……

}

最后，不写注释的应该统统枪毙。。