JAVA基础 javadoc一些标签示例

这里将介绍一些可用于代码文档的Javadoc标签。在使用javadoc处理重要事情之前，应该先到JDK文档哪里查阅javadoc参考，以学习Javadoc的各种不同的使用方法。
1、@see: 引用其他类
@see标签允许用户引用其他类的文档。javadoc会在其中生成的HTML文件中，通过@see标签连接到其他文档 ，格式如下：@see classname
@see  fully-qualified-classname
上述每种格式都会在生成的文档中加入一个具有超链接的"See Also" (参见)条目。但是Javadoc不会检查你所提供的超链接是否有效。
2、{@link package.class#member label}
该标签与@see极其相似，只是它用于行内，并且是用“label”作为超链接文本而不用“See Also”。
3、{@docRoot}
该标签产生到文档跟目录的相对路径，用于文档数页面的显示超链接。
4、{@inheritDoc}
该标签从当前这个类的最直接的基类中继承相关文档到当前的文档注释中。
@version version-information
其中，“version-information”可以是任何你认为合适包含在版本说明中的重要信息。如果Javadoc命令行使用了“-version”标记，那么就从生成的HTML文档中特别提取出版本信息。
6、@author author-information
其中，author-information一看便知是你的姓名，但是也可以包括电子邮件地址或者其他任何适宜的信息。如果javadoc命令是哟个了-author标记，那么就从生成的HTML文档中特别提取作者信息。
可以使用多个标签，一般列出所有作者，但是他们必须连续放置。全部作者信息会合并到同一段落，置于生成的html中。