密级: 内部公开
DKBAXXXX-2001.12
注释规范
IIN V100R001 WEBSMAP
(C) 版权所有 2000-2001 华为技术有限公司
4.
文件注释:文件注释写入文件头部,包名之前的位置。
说明:注意以 /* 开始避免被 JavaDoc 收集 示例: /*
* 注释内容 */
package com.huawei.iin.websmap.comm;
5.
文件注释内容:版权说明、描述信息、生成日期、修改历史。
说明:文件名可选。
格式: /*
* 文件名:[文件名] * 版权:〈版权〉 * 描述:〈描述〉 * 修改人:〈修改人〉 * 修改时间:YYYY-MM-DD * 跟踪单号:〈跟踪单号〉 * 修改单号:〈修改单号〉 * 修改内容:〈修改内容〉 */
说明:每次修改后在文件头部写明修改信息,CheckIn的时候可以直接把蓝色字体信息粘
贴到VSS的注释上。在代码受控之前可以免去。
2005-10-15, 11:40:39
21
密级: 内部公开
DKBAXXXX-2001.12
注释规范
示例: /*
* 文件名:LogManager.java
* 版权:Copyright 2000-2001 Huawei Tech. Co. Ltd. All Rights Reserved. * 描述: WIN V200R002 WEBSMAP 通用日志系统 * 修改人: 张三 * 修改时间:2001-02-16 * 修改内容:新增 * 修改人: 李四 * 修改时间:2001-02-26 * 跟踪单号:D20103 * 修改单号:WSS368 * 修改内容:。。。。。。 * 修改人: 王五 * 修改时间:2001-03-25 * 跟踪单号:D27153 * 修改单号:WSS498 * 修改内容:。。。。。。 */
6.
类和接口的注释:该注释放在 package 关键字之后,class 或者 interface
关键字之前。
说明:方便JavaDoc收集 示例:
package com.huawei.iin.websmap.comm; /**
* 注释内容 */
public class CommManager
2005-10-15, 11:40:39
22
密级: 内部公开
DKBAXXXX-2001.12
注释规范
7.
类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描
述,
说明:可根据需要列出:版本号、生成日期、作者、内容、功能、与其它类的关系等。
如果一个类存在Bug,请如实说明这些Bug。
格式: