二、编码规范 CheckList

序

号

内容

Y/N

备注

1

文件起始注释


文件名（必须）、创建日期、Copyright 信息



文件修改记录：修改人、修改时间、修改原因等

文件注释举例：
/**
 * @(#)Blah.java 1.102 ,Created on 2008-4-22
 *
 * Copyright (c) XXXXX
 *
 * MODIFY MEMO:
 * zhangsan/2001_01_11/modify……,……;
 * zhanghai/2001_01_31/add……,…….
 */

2

类的注释


类功能描述、注意事项等。（必须）



           

版本号

@version 版本信息  （必须）



         

作者信息

@author 

       

作者

（必须）



支持的 JAVA

   

版本 @since  JAVA

   

版本 （可选）



   

引用其他类文档 @see   

     

完整类名

（可选）

示例：
/**
 * Class description goes here.
 *
 *@version    1.102
 *@author    Firstname Lastname
 *@since   JDK1.4
 */

3

方法的注释
函数实现时在函数体前要对函数的功能、注意事项做描述；


参数用：@param 

 

参数名 参数描述 表示，一个参数一行

（方法有参数则必须）;



 

返回值用： @return 返回说明 表示；（有返回则必须）；



  

违例用 ：

@throws 违例类 

 

说明 表示，一个违例一行；

（有违例则必须）尽可能列举出所有会抛出此异常的情况；



类名#

 

方法名 表示；（可选）；