自定义java Doclet的调试

最新推荐文章于 2024-02-22 01:44:24 发布

ykdsg

最新推荐文章于 2024-02-22 01:44:24 发布

阅读量3.7k

点赞数

CC 4.0 BY-SA版权

分类专栏： java

本文链接：https://blog.youkuaiyun.com/ykdsg/article/details/8694563

java 专栏收录该内容

37 篇文章

订阅专栏

本文介绍如何通过自定义Javadoc Doclet简化接口文档的生成流程。通常在更新代码后同步更新文档会带来额外的工作负担，因此作者选择通过编写自定义的Doclet来解决这一问题。文章详细解释了Doclet的概念及其工作原理，并提供了实现自定义Doclet的具体步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

工作中经常需要对外提供接口，这个时候接口的文档就非常麻烦，同时是维护在wiki或者其他地方，但是修改代码之后很可能没有及时更新wiki，造成很多交流的成本。所以想直接通过javadoc 生成接口文档的方式。发现maven提供的javadoc插件，但是原生的Doclet不能满足我的要求。所以需要自己定义doclet。来看下Doclet的定义：

Doclet 是用 JavaTM编程语言编写的程序，它用 doclet API 指定 Javadoc 工具的输出内容和格式。缺省情况下，Javadoc 工具用 SunTM 提供的“标准” doclet 来生成 HTML 形式的 API 文档。然而，用户也可用自己的 doclet 根据个人喜好自定义 Javadoc 输出。用户可以利用 doclet API从头开始编写 doclet，也可以对标准 doclet 进行修改，以适合自己的需要。
下面是创建和使用自己的 doclet 的基本步骤：

1. 编写用来构成 doclet 的 Java 程序。为使用 doclet API，该程序应导入 com.sun.javadoc.*。程序的入口点是一个带有 public static boolean start 方法的类，它将 RootDoc 作为参数。
2. 编译 doclet。可以使用 Java Development Kit 的编译器 javac 来编译它。
3. 用 -doclet <YourDoclet> 选项运行 javadoc 工具，生成 doclet 指定的输出。

doclet API 类文件在 JDK 软件的 lib/tools.jar 文件中。当编译 doclet 和使用自定义 doclet 时，tools.jar 必须在类路径上。为此，可以对 javac 和 javadoc 使用 -classpath 选项。

这里说到了doclet需要使用tools.jar，在使用ide比如idea时在project setting中对jdk的classpath加上tools.jar的路径就可以了。但是这货调试太麻烦了，根据网上的资料只能在外面先编译好你的Doclet ，然后用javadoc -doclet 指定编译好的doclet。但是这样不能debug doclet程序，重新找了下网上的资料加上自己的时间，发现可以这样搞

public class APIDoclet {


    public static boolean start(RootDoc root) {
        ClassDoc[] classes = root.classes();
        for (int i = 0; i < classes.length; ++i) {
            System.out.println(classes[i]);
        }
        return true;
    }


    public static void main(String[] args) {
        String[] docArgs = new String[]{"-doclet", APIDoclet.class.getName(), System.getProperty("user.dir") + "/src/main/java/" + "com/hz/yk/concurrent/aqs/BooleanMutex.java"};
        com.sun.tools.javadoc.Main.execute(docArgs);
    }

}

哈哈哈，这下可以打断点了

附上doclet 的资料：

http://dadi520.iteye.com/blog/545897