【 用DOS命令生成API文档,Javadoc命令详解】

用DOS命令生成API文档,Javadoc命令详解

---

文档注释有什么用呢?

通过DOS命令生成API文档

javadoc 工具将你 Java 程序的源代码作为输入，输出一些包含你程序注释的HTML文件。

每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。

由于 javadoc 的实现不同，工作也可能不同，你需要检查你的 Java 开发系统的版本等细节，选择合适的 Javadoc 版本。

---

Javadoc标签

@author	标识一个类的作者	@author description
@deprecated	指名一个过期的类或成员	@deprecated description
{@docRoot}	指明当前文档根目录的路径	Directory Path
@exception	标志一个类抛出的异常	@exception exception-name explanation
{@inheritDoc}	从直接父类继承的注释	Inherits a comment from the immediate surperclass.
{@link}	插入一个到另一个主题的链接	{@link name text}
{@linkplain}	插入一个到另一个主题的链接，但是该链接显示纯文本字体	Inserts an in-line link to another topic.
@param	说明一个方法的参数	@param parameter-name explanation
@return	说明返回值类型	@return explanation
@see	指定一个到另一个主题的链接	@see anchor
@serial	说明一个序列化属性	@serial description
@serialData	说明通过writeObject( ) 和 writeExternal( )方法写的数据	@serialData description
@serialField	说明一个ObjectStreamField组件	@serialField name type description
@since	标记当引入一个特定的变化时	@since release
@throws	和 @exception标签一样.	The @throws tag has the same meaning as the @exception tag.
{@value}	显示常量的值，该常量必须是static属性。	Displays the value of a constant, which must be a static field.
@version	指定类的版本	@version info

---

用DOS命令生成API文档

首先创建一个空白的Java文档,输入以下代码

public class TestDemo04 {
    /**
     * @author lin
     * @version 2022.1.1
     * @since 1.8
     */
    public static void main(String[] args) throws Exception {
        int i = 10;
        int j = 20;
        String z = i > j ? "i大于j" :"i小于j";
        System.out.println(z);
        TestDemo04 testDemo04 = new TestDemo04();
        System.out.println(testDemo04.circle(testDemo04.radius));
    }

    static final double PI = 3.1415926969;
    double radius = 5.69;

    /**
     * @param radius
     * @return area
     * @param radius
     * @throws Exception
     */
    public double circle(double radius) throws Exception{
        double area = PI * Math.pow(radius,2);
        return area;
    }
}

将文件名命名为TestDemo04.java

在目录下找到该选项打开Java文件所在位置

选择Open in 下的 Explorer,在任务导航框开头加入cmd+ 空格 + 回车,打开cmd窗口

输入javadoc -author -version TestDemo04.java 命令

会在该文件下生成对应的HTML文档

我们打开index.heml进入首页

这就是通过DOS命令生成的API文档