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: 2018/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{
.................
}
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;
}
}
- 字段注释
字段注释在定义字段的前面,用来描述字段的含义。下面是一个字段注释的例子。
/**
* 用户名
*/
public String name;
也可以使用如下格式:
/**用户名*/
public String name;
在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序。注释对于程序的可读性来说是非常重要的,希望读者不要忽视它。
相关文章
- 利用Xposed Hook打印Java函数调用堆栈信息的几种方法
- java代码调试,打印代码方法执行时间(毫秒级)
- java基础 ArrayList集合基本方法演示
- Jsp中无法使用EL表达式的解决方法错误Can not find the tag library descriptor for http://java.sun.com/jsp/jstl/core
- JRuby中调用java带可变参数的方法
- Java IO教程
- Java7 java.util.concurrent 并发包计划
- [转] Java序列化与反序列化
- zeromq简介及各个通讯模式实例详解(附java实现)
- 系统学习JAVA第十五天(Match类下的方法,日期相关类,处理异常)
- Java中常用的加密方法(JDK)
- alue of type java.lang.String cannot be converted to JSONObject
- java 使用反射调用方法
- 《大规模Java平台虚拟化与调优》——第2章 现代化可扩展的数据平台
- java使用jsp servlet来防止csrf 攻击的实现方法
- 详解Java中的clone方法 -- 原型模式
- java中Scanner类nextLine()和next()的区别和使用方法
- SpringBoot入门二(java代码方式配置)
- Java之相对路径找不到文件问题解决方法
- Java方法——详解
- java 虚方法。 后面new 那个类, 就调用哪个类的方法 ,而非定义类的方案。 关于父子 类的 呵呵
- Eclipse运行项目时报错 java.net.BindException: Address already in use 的解决方法
- Java对存储过程的调用方法 --转载
- Java的集合排序:Collections.sort、list.sort和list.stream().sorted方法详解