java java.doc_java之javadoc

1. 简述

​ 使用 /** 开始 */结束的语法声明，这是一个javadoc格式的注释

/**后第一句就是概要性的文字，javadoc程序会把这些句子取出来，形成概要页

2. 类注释、域注释

​ 放在import之后，类定义之前

package com.example.test;

import java.util.List;

/**

* this is test myclass

*/

public class MyClass {

}

​ 对公共域，通常指的是静态变量进行建立文档

/**

* the HEAD is xxx

*/

public static int HEAD = 1;

3. 方法注释

​ 方法注释在每一个方法之前

​ 除了第一个描述之外可以加上如下标记

​ @param变量描述

​ 对当前方法的param参数添加一个条目。描述可以占据多行。但是所有@param标记要放在一起

​ @return描述

​ 对当前方法的返回值进行描述，可以占据多行

​ @throw

​ 添加注释，对可能抛出的异常进行描述

/**

* print class information

* @param aa is param, as text

* @return include all print text

*/

public String printMyClass(int aa) {

return "";

}

4. 通用注释

最常用的

@link

用作增加超链接，可以用于类中，也可以用域方法中

使用方法 ： {@link 包名.类名#方法名 + 其他注释}

包名.类名#方法名这个就是可以点击的超链接可以跳转

注意的是#这个一定不能忘记

可以省略包名，甚至把包名和类名都省略，链接定位到当前的包或当前类

@deprecated

和注解含义相同，标记某一方法变量不再使用

其他

@author

产生一个author条目。使用多个@author标记，每个author对应一个作者

@version文本

产生version版本，对当前的版本进行任意描述

下面的注释可以用在所有文档注释中

@since文本

产生since条目。这里的text针对引入特性的版本进行描述。例如 @since version 1.7.

@see引用

这个标记将在 "see also" 部分增加一个超链接。可以用于类中，也可以用域方法中

方法

/**

* 跳转到指定类

* {@link TestController}

* 跳转到指定类的指定方法

* @see TestController#queryUser(String)

*

* @return

*/

5. 生成HTML的注释

​ javadoc -d test com/example/test/MyClass.java

​ -d 后面接想文档生成的文件夹路径

​ com/example/test/MyClass.java代表对哪个java文件进行生成注释处理，可以连续写多个