华为JAVA编程规范(5)

规则5 公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、

输出参数、返回值、异常等。(1.42+)

格式： /**

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

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

* @exception/throws [异常类型] [异常说明] * @see [类、类#方法、类#成员] * @since [起始版本] * @deprecated */

说明：@since 表示从那个版本开始就有这个方法，如果是最初版本就存在的方法无需说明；@exception或throws 列出可能仍出的异常；@deprecated 表示不建议使用该方法。 示例： /**

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

* 分配对应日志类型的LogReader， 指定类型、查询时间段、条件和反复器缓冲数， * 读取日志记录。查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。 * 查询时间为左包含原则，即 [startTime, endTime) 。 * @param logTypeName 日志类型名（在配置文件中定义的） * @param startTime 查询日志的开始时间 * @param endTime 查询日志的结束时间 * @param logLevel 查询日志的级别 * @param userName 查询该用户的日志 * @param bufferNum 日志反复器缓冲记录数

* @return 结果集，日志反复器 * @since 1.2 */

public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)

规则6 对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他

方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。(1.42+)

说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime异常，@throws标注非Runtime异常。异常的注释必须说明该异常的含义及什么条件下抛出该异常。

Page 5 , Total 19