密级： 内部公开

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。

格式：

/**

* 〈一句话功能简述〉 * 〈功能详细描述〉 * @author [作者]

* @version [版本号, YYYY-MM-DD] * @see [相关类/方法] * @since [产品/模块版本] * @deprecated */

说明：描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加

作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated

表示不建议使用该类或者接口。

示例： /**

* LogManager 类集中控制对日志读写的操作。

* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写

器，

* 读取或写入符合条件的日志纪录。 * @author 张三，李四，王五 * @version 1.2, 2001-03-25 * @see LogIteraotor * @see BasicLog * @since CommonLog1.0

2005-10-15, 11:40:39

23

密级： 内部公开

DKBAXXXX-2001.12

注释规范

*/

8.

类属性、公有和保护方法注释：写在类属性、公有和保护方法上面。

示例： /**

* 注释内容 */

private String logType; /**

* 注释内容 */

public void write() 方。

10.

公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描

9.

成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地

述、输入参数、输出参数、返回值、违例等。 格式：

/**

* 〈一句话功能简述〉 * 〈功能详细描述〉

* @param [参数1] [参数1说明] * @param [参数2] [参数2说明] * @return [返回类型说明]

* @exception/throws [违例类型] [违例说明] * @see [类、类#方法、类#成员] * @deprecated */

24

2005-10-15, 11:40:39

密级： 内部公开

DKBAXXXX-2001.12

注释规范

说明：@since 表示从那个版本开始就有这个方法；@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。

示例： /**

* 根据日志类型和时间读取日志。

* 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器

缓冲数，

* 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0

读不到日志。

* 查询时间为左包含原则，即 [startTime, endTime) 。 * @param logTypeName 日志类型名（在配置文件中定义的） * @param startTime 查询日志的开始时间 * @param endTime 查询日志的结束时间 * @param logLevel 查询日志的级别 * @param userName 查询该用户的日志 * @param bufferNum 日志反复器缓冲记录数 * @return 结果集，日志反复器 * @since CommonLog1.0 */

public static LogIterator read(String logType, Date startTime, Date

endTime,

int logLevel, String userName, int

bufferNum)

11.

对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，

对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非

RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。

2005-10-15, 11:40:39

25