使用javadoc生成jdk api文档（最后附上JDK1.8官方在线文档地址）

时间：2024-02-22 14:42:50

使用javadoc生成jdk api文档

javadoc命令是用来生成自己的API文档的。在编写java代码时，可以对类和方法进行文档注释，写上相应的说明，比如@author、@version、@param、@return等等。然后，使用javadoc命令，即可将自己写的文档注释输出成一份API文档。

比如下列代码中，对类和方法都添加了文档注释，对相应参数予以说明。

package com.baidu.www;
import java.util.concurrent.TimeUnit;
​
//以下是对类的文档注释
/**
 * @author cc
 * @version 1.0
 * @since 1.8
 */
public class Test {
    public static void main(String[] args) {
        System.out.printf("123");
    }
//以下是对方法的文档注释
    /**
     *
     * @param a 1
     * @return 123
     * @throws Exception
     */
    public String haha(int a) throws Exception{
        System.out.println(123);
        return "123";
    }
}

java代码写好之后，就可以生成对应的api文档了。

生成api文档方法1：使用cmd命令

  1. 找到java代码对应的文件夹，进入cmd控制台

  1. 进入控制台后，输入命令javadoc -encoding UTF-8 -charset UTF-8 Test.java，命令中-encoding UTF-8 -charset UTF-8是为了更好的适应中文字符，减少乱码错误，Test.java就是需要生成api文档的java代码。

  1. 在步骤2运行结束后，可以看到Test.java所在文件夹多了很多文件

  1. 新增的文件中，index.html是文档的首页，双击打开，可以看到api文档的首页

  1. 点击Test类打开，即可看到在java代码中添加的文档注释的具体内容。

生成api文档方法2：使用IDEA

  1. 打开IDEA的Tools菜单栏，选择Generate JavaDoc

  1. 根据自己想要生成api文档的范围进行选择。此处为了跟cmd示例保持一致，选择Test.java。将Output directory和参数填写之后，点击OK

  1. 在IDEA可以看到Javadoc执行完毕，然后自动打开了生成完毕的api文档。这个文档跟上面用cmd命令生成的一致。

最后附上JDK1.8官方在线文档地址https://docs.oracle.com/javase/8/docs/api/

 

相关文章