Java注释：类、⽅法和字段注释
⼀个程序的可读性，关键取决于注释。如果⼀个程序想⼆次开发，要读懂前⾯的程序代码，就必须在程序中有⼤量的注释⽂档，所以对于⼀个优秀的程序员来说，学会在程序中适当地添加注释是⾮常重要的。
我们会简单地介绍类、⽅法、字段等地⽅的注释⽅法，这些地⽅的注释虽然简单但是在开发⼯作中却是⾮常重要的。
注意：本节注释使⽤⽂档注释。多⾏注释的内容不能⽤于⽣成⼀个开发者⽂档（⽂档提供类、⽅法和变量的解释，也可称为帮助⽂档），⽽⽂档注释可以。
1. 类注释
类注释⼀般必须放在所有的“import”语句之后，类定义之前，主要声明该类可以做什么，以及创建者、创建⽇期、版本和包名等⼀些信息。以下是⼀个类注释的模板。
/**
* @projectName（项⽬名称）: project_name
* @package（包）: package_name.file_name
* @className（类名称）: type_name
* @description（类描述）: ⼀句话描述该类的功能
* @author（创建⼈）: user
* @createDate（创建时间）: datetime
* @updateUser（修改⼈）: user
* @updateDate（修改时间）: datetime
* @updateRemark（修改备注）: 说明本次修改内容
* @version（版本）: v1.0
*/
提⽰：以上以@开头的标签为 Javadoc 标记，由@和标记类型组成，缺⼀不可。@和标记类型之间有时可以⽤空格符分隔，但是不推荐⽤空格符分隔，这样容易出错。
⼀个类注释的创建⼈、创建时间和描述是不可缺少的。下⾯是⼀个类注释的例⼦。
/**
* @author: zhangsan
* @createDate: 2019/10/28
* @description: this is the student class.
*/
public class student{
.................
}
注意：没有必要在每⼀⾏的开始⽤*。例如，以下注释同样是合法的：
/**
@author: zhangsan
@createDate: 2018/10/28
@description: this is the student class.
*/
public class student{
.................
param name}
2. ⽅法注释
⽅法注释必须紧靠在⽅法定义的前⾯，主要声明⽅法参数、返回值、异常等信息。除了可以使⽤通⽤标签外，还可以使⽤下列的以@开始的标签。
@param 变量描述：对当前⽅法的参数部分添加⼀个说明，可以占据多⾏。⼀个⽅法的所有@param 标记必须放在⼀起。
@return 返回类型描述：对当前⽅法添加返回值部分，可以跨越多⾏。
@throws 异常类描述：表⽰这个⽅法有可能抛出异常。有关异常的详细内容将在第 10 章中讨论。
下⾯是⼀个⽅法注释的例⼦。
/**
* @param num1: 加数1
* @param num2: 加数2
* @return: 两个加数的和
*/
public int add(int num1,int num2){
int value = num1 + num2;
return value;
}
以上代码的 add() ⽅法中声明了两个形参，并将它们两个的和作为返回值返回。
为类的构造⽅法添加注释时，⼀般声明该⽅法的参数信息，代码如下。
public class Student {
String name;
int age;
/**
* @description: 构造⽅法
* @param name: 学⽣姓名
* @param age: 学⽣年龄
*/
public Student(String name,int age){
this.name = name;
this.age = age;
}
}
3. 字段注释
字段注释在定义字段的前⾯，⽤来描述字段的含义。下⾯是⼀个字段注释的例⼦。
/**
* ⽤户名
*/
public String name;
也可以使⽤如下格式：
/**⽤户名*/
public String name;
在 Java 的编写过程中我们需要对⼀些程序进⾏注释，除了⾃⼰⽅便阅读，更为别⼈更好理解⾃⼰的程序。注释对于程序的可读性来说是⾮常重要的，希望⼤家不要忽视它。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。