华为JAVA编程规范(4)

规则3 类和接口的注释放在class 或者 interface 关键字之前，import 关键字之后。注

释主要是一句话功能简述与功能详细描述。类注释使用“/** */”注释方式(1.42+)

说明：方便JavaDoc收集,没有import可放在package之后。注释可根据需要列出：作者、内容、功能、与其它类的关系等。功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项，每次修改后增加作者和更新版本号和日期，@since 表示从那个版本开始就有这个类或者接口，@deprecated 表示不建议使用该类或者接口。 /**

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

* @author [作者]（必须）

* @see [相关类/方法]（可选） * @since [产品/模块版本] （必须） * @deprecated （可选） */

示例：

package m;

import java.util.*; /**

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

* 全部为静态变量和静态方法，对外提供统一接口。分配对应日志类型的读写器， * 读取或写入符合条件的日志纪录。

* @author 张三，李四，王五 * @see LogIteraotor * @see BasicLog

* @since CommonLog1.0 */

public class LogManager

规则4 类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方

式为“/** */”.(1.42+)

示例： /**

* 注释内容 */

private String logType; /**

* 注释内容 */

public void write()

Page 4 , Total 19