这篇教程Java 文档注释写得很实用，希望能帮到您。
Java 支持三种注释方式。前两种分别是 // 和 /* */，第三种被称作说明注释，它以 /** 开始，以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息，并输出到HTML文件中。 说明注释，使你更加方便的记录你的程序信息。 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( ) 和
Java Applet 基础
Java 8 新特性 |
|
