利用javadoc生成API文档

    写代码的时候免不了要查看API,jdk的API在官网上也能查看,但是是在线的.对于我们这种上班时间不允许上

网的人来说就很....

当然也可以从网上下载现成API文档,但总有一些API是你很难从网上下载的,授人予鱼不如授人予渔.给大家介

绍一个如何生成java API文档的方法.模仿这一过程可以生成各种开源jar 的API文档.

    以生成JDK1.8的API为例

1.首先从官网下载、安装、配置JDK，

2.进入jdk的安装目录，找到src.zip并解压(最好解压到其他目录)

3.只保留java、javax、org这三个目录

4.找到所有的java文件并将其路径写入一个文件(本示例为解压目录src下的package.txt)

这一步肯定不能自己去做,写段代码用来生成这个文件,代码在文章最后会附上

5.进入Windows命令窗口(cmd),输入如下命令

(1)cd [path] 

注意:path为解压的目录,如文件位于d://src目录下则命令为cd d://src

(2)javadoc -d ../api @package.txt

../api表示生成文档的目录,当前目录的父目录下的api目录,package.txt为步骤4所生成的文件

以上命令运行完之后就能看到API文档了,最后一个命令要执行10分钟左右,耐心等待吧.

注意!在执行命令(2)后会开始加载java,一定要在加载完之后按一下回车.否则javadoc不会继续执行

下面是查找java文件的代码:

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.stream.Stream;

public class FilesMain {
    
    public static void main(String[] args) throws IOException {
        Path src = Paths.get("java原文件地址(src)");
        Path pa = Paths.get("需要生产的package.txt文件地址");
        List list = new ArrayList();
        try(Stream st = Files.walk(src)){
            Iterator it = st.iterator();
            while(it.hasNext()){
                Path p = it.next();
                if(!Files.isDirectory(p)){
                   if(p.toString().endsWith(".java")){
                       list.add(p.toString());
                   }
                }
            }
            Files.write(pa, list);
        }
        System.out.println("完成!");

    }
}

我已经上传了一份jdk1.8的中文API,有需要的可以下载

https://download.csdn.net/download/rongbaojian/10422952