java文档注释

Posted 2021-02-13 kali5k

1. 语法

所有javadoc命令都只能在 “/**注释内容 */”注释出现

1. 方式
2. 嵌入html或叫文档标签
3. 行内文档标签

一般都以“@”字符开头

1. 类型

3.1：共有三种类型：类，域，方法（都定义类型之前）

1. 以“@”开头的标签

(1) @see:标签允许用户引用其他类的文档，java会在生成的HTML文件中，设置超链接到其他文档。格式如下：

@see 类名

@see 完整类名（例如：java.lang.String）

@see 完整类名#方法名（例

如:java.lang.String#toString）

(2) @link :插入一个到另一个主题的链接

{@link package.class#member laber}

(3) {@docRoot} :指明当前文档根目录的路径

(4) {@inheritDoc}:从直接父类继承的注释

(5) @version : 类的版本

(6) @author：作者

(7) @since :指定所用的JDK版本的情况

(8) @param :指定方法的参数

(9) @return ：返回值

(10) @throws : 指定抛出异常

(11) @Deprecated :标识一个类的作者

一般来说在编程中常用的是：@author,@param,@retrun,@throws,@version