Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */ 结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到 HTML 文件中。
说明注释，使你更加方便的记录你的程序信息。
Java 支持以下三种注释方式：
- 单行注释：以双斜杠
//标识，只能注释一行内容，用在注释信息内容少的地方。
public class Main{
public static void main(String[] args) {
//这是单行注释
System.out.println("注释方式");
}
}
- 多行注释：包含在
/*和*/之间，能注释很多行的内容。为了可读性比较好，一般首行和尾行不写注释信息（这样也比较美观好看）。
注意：多行注释可以嵌套单行注释，但是不能嵌套多行注释和文档注释。
public class Main{
public static void main(String[] args) {
/*
* 这是多行注释
* 可以注释多行内容
*/
System.out.println("注释方式");
}
}
- 文档注释：包含在
/**和*/之间，也能注释多行内容，一般用在类、方法和变量上面，用来描述其作用。注释后，鼠标放在类和变量上面会自动显示出我们注释的内容。
注意：文档注释能嵌套单行注释，不能嵌套多行注释和文档注释，一般首行和尾行也不写注释信息。
public class Main{
/**
* 这是文档注释
* 可以注释多行内容
* @param args
*/
public static void main(String[] args) {
System.out.println("注释方式");
}
}
javadoc 标签
javadoc 工具软件识别以下标签：
| 标签 | 描述 | 示例 |
|---|---|---|
| @author | 标识一个类的作者 | @author description |
| @deprecated | 指名一个过期的类或成员 | @deprecated description |
| {@docRoot} | 指明当前文档根目录的路径 | Directory Path |
| @exception | 标志一个类抛出的异常 | @exception exception-name explanation |
| {@inheritDoc} | 从直接父类继承的注释 | Inherits a comment from the immediate surperclass. |
| {@link} | 插入一个到另一个主题的链接 | {@link name text} |
| {@linkplain} | 插入一个到另一个主题的链接，但是该链接显示纯文本字体 | Inserts an in-line link to another topic. |
| @param | 说明一个方法的参数 | @param parameter-name explanation |
| @return | 说明返回值类型 | @return explanation |
| @see | 指定一个到另一个主题的链接 | @see anchor |
| @serial | 说明一个序列化属性 | @serial description |
| @serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
| @serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
| @since | 标记当引入一个特定的变化时 | @since release |
| @throws | 和 @exception标签一样. | The @throws tag has the same meaning as the @exception tag. |
| {@value} | 显示常量的值，该常量必须是static属性。 | Displays the value of a constant, which must be a static field. |
| @version | 指定类的版本 | @version info |
对两种标签格式的说明：
@tag格式的标签（不被{ }包围的标签）为块标签，只能在主要描述（类注释中对该类的详细说明为主要描述）后面的标签部分（如果块标签放在主要描述的前面，则生成API帮助文档时会检测不到主要描述）。- {
@tag} 格式的标签（由{ }包围的标签）为内联标签，可以放在主要描述中的任何位置或块标签的注释中。
Javadoc 标签注意事项：
Javadoc标签必须从一行的开头开始，否则将被视为普通文本。- 一般具有相同名称的标签放在一起。
Javadoc标签区分大小写，代码中对于大小写错误的标签不会发生编译错误，但是在生成API帮助文档时会检测不到该注释内容。
文章转自:
