【基础学习--数据结构】java中注释规范

一、Java 中注释规范

1、类注释

一般地，要在每个类前面必须加上类注释，注释模板范例如下：

/**
* Copyright (C), 2008-2018, Meritco Services info. Co., Ltd.
* FileName: Test.java
* 类详细说明
*
* @author  类创建者姓名
* @Date    创建日期
* @version 1.0.0
*/

2、属性注释

一般地，在每个属性前面必须加上属性注释，注释范例模板如下：

/** 属性信息 */
private String strName = null;

3、方法注释

一般地，在每个方法前面必须加上方法注释，注释范例模板如下：

/**
* 类方法的详细使用说明
*
* @param  参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

4、构造方法注释

在每个构造方法前面必须加上注释，注释模板如下：

/**
* 构造方法的详细使用说明
*
* @param  参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

5、方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

如：如：

//背景长度
Length bgLength = Length.LONG