java之javadoc

------------恢复内容开始------------

简述

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

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

类注释

放在import之后，类定义之前

    package com.example.test;
import java.util.List;

/**
 * this is test myclass
 */
public class MyClass {
}

方法注释

方法注释在每一个方法之前
除了第一个描述之外可以加上如下标记
@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 "";
    }

域注释

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

     /**
     * the HEAD is xxx
     */
    public static int HEAD = 1;

通用注释

类文档的注释：
在类文档开头中体现
@author
产生一个author条目。使用多个@author标记，每个author对应一个作者
@version文本
产生version版本，对当前的版本进行任意描述
下面的注释可以用在所有文档注释中
@since文本
产生since条目。这里的text针对引入特性的版本进行描述。例如  @since version 1.7.1
@deprecated文本
这个标记对类、方法或变量田间一个不再使用的注释
通过#see和@link标记，使用超链接，链接到javadoc文档的相关部分或外部文档‘
@see引用
这个标记将在 "see also" 部分增加一个超链接。可以用于类中，也可以用域方法中
常用的
@see  com.horstmann.testjava#testclass(double)
建立链接到com.horstmann.testjava.testclass中。可以省略包名，甚至把包名和类名都省略，链接定位到当前的包或当前类
注意的是一定使用#标识类名和方法或变量
如果@see后面有一个<字符，代表套进行超链接，链接到任意URL
@see <a href="www.baidu.com>The Core</a>
如果@see后面有双引号字符，文本会在 see also部分显示
@see "Core java 2"

生成HTML的注释

javadoc -d test com/example/test/MyClass.java
-d 后面接想文档生成的文件夹路径
com/example/test/MyClass.java代表对哪个java文件进行生成注释处理，可以连续写多个

java之javadoc

原文：https://www.cnblogs.com/zero-waring/p/13246274.html