java 代码块注释_java注释（类、构造函数、方法、代码块、单行、属性注释）

1、类注释(Class)

类注释(Class)主要用来声明该类用来做什么，以及创建者、创建日期版本、包名等一些信息:

/**

* @version: V1.0

* @author: XXXX

* @className: Student

* @packageName: xxxxx

* @description: 这是学生信息类

* @data: 2017-07-28 12:20

**/

2、构造函数注释(Constructor)

构造函数注释(Constructor)主要用来声明该类的构造函数、入参等信息:

**

* @description: 构造函数

* @param: [sid, pid]

*/

3、方法注释(Methods)

方法注释(Methods)主要用来声明该类的作用、入参、返回值、异常等信息:

/**

* @author: XXXX

* @methodsName: saveInfo

* @description: 保存信息

* @param: xxxx

* @return: String

* @throws:

*/

4、代码块注释(Block)

/**

* 实例化一个用户

* xxxxxxx

*/

User user=new User();

5、单句注释

//实例化一个用户

Student stu=new Student ();

6、字段名注释

/**

* 用户名

*/

public String name;