关于 javadoc

Posted 2020-09-09 Zview

javadoc可以帮助我们编写的代码生成相关的说明文档（API文档），这个参考官方的java API ，

通过你使用的javadoc标签，javadoc可以将你的程序中的相关api内容呈现出来，通过/**  */的方式将注释写入到javadoc文档中

一，java注释

// 注释一行
/* ...... */ 注释若干行

/** ...... */ 注释若干行，并写入 javadoc 文档
或者是这样写
/**
* .........
* .........
*/

只有第三种方式的注释会被写入到javadoc中

二、javadoc命令

javadoc -d 文档存放目录 -author -version 源文件名.java

javadoc -d c:\doc -sourcepath c:\src -subpackages com.liigo -author -version

-d 指定API文档的输出目录，默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径，默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数！如果不使用本参数，每次只能处理一个子包（或需手工列出所有子包）。
-author 可以将作者信息（@author ***）导出到最终生成的API文档中
-version 可以生成版本信息。

这个命令生成html格式的API文档，文档中的相关内容都是通过用户写的注释和javadoc标记来实现的

三、javadoc注释的结构

第一部分是简述。文档中，对于属性和方法都是先有一个列表，然后才在后面一个一个的详细的说明 
简述部分写在一段文档注释的最前面，第一个点号 (.) 之前 (包括点号)。换句话说，就是用第一个点号分隔文档注释，之前是简述，之后是第二部分和第三部分。
第二部分是详细说明部分。该部分对属性或者方法进行详细的说明，在格式上没有什么特殊的要求，可以包含若干个点号。 
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
简述也在其中。这一点要记住了
第三部分是特殊说明部分，也就是javadoc标签。这部分包括版本说明、参数说明、返回值说明等。

/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示，false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}

四、javadoc标签

@author 标明开发该类模块的作者 
@version 标明该类模块的版本 
@see+类名  参考转向，也就是相关主题 ,就是文档中的"另请参阅XXX"
@param 对方法中某参数的说明 
@return 对方法返回值的说明 
@exception 对方法可能抛出的异常进行说明 
五、其他

之前Annotation中，记得有一个@Documented的元注解，当一个注解被@Documented修饰的时候，这个注解会被写入到文档中。