2-2编码规范

电子政务和政务公开业务处理信息系统—系统编码规范

1.4.5 注释

注释是软件可读性的具体体现。程序注释量一般占程序编码量的20%，软件工程要求不少于20%。以下是四种必要的注释：

（1） 类说明注释

注释一般位于 package/import 语句之前，class 描述之前。要求至少写出内容说明、创建者、创建时间和特别注意事项等内容。例如： /**

* 名称: ${file_name}
* 描述:
* 类型: JAVA

* 最近修改时间:${date} ${time}
* @since ${date} * @author 刘 华 */

（2） 方法说明注释

对几乎每个方法都应有适当的说明，位于方法声明之前，包括：说明，参数说明、异常说明、返回值说明和特别说明等。例如： /** * 方法描述 *

* ${tags}

* @param id String唯一标识 * @param personid String 用户唯一标识 * @return rtobj BaseReturn 基本返回对象 * @变更记录 ${date} ${time} 刘 华 创建

- 5 -

电子政务和政务公开业务处理信息系统—系统编码规范

* */

（3） 体内代码的注释

体(方法体、代码块体、静态代码块体等)内的代码按照功能分成多个虚拟的功能块，每个块以块注释“/* xxx */”注释开始，以空行结束；例如： /**是否超级管理员**/

private Boolean isadmin = false;

if(null!=curOuId&&!curOuId. equals (“”)) {

/*组织机构ID不为空时 */ curOuId = ?000000?; 空行 } 空行

if(curOuId==null) {

/*组织机构ID为空时 */ }

（4） 行注释

行注释“//”仅用于调试注释，在程序稳定之后，行注释必须被删除，以免影响程序的可读性。

- 6 -