通过自定义java doclet定制接口文档

【声明】本文为AdamsLee原创,转载请注明出自围炉网并保留本文有效链接:通过自定义java doclet定制接口文档, 转载请保留本声明!
  1. doclet 简介
    • Doclet 是用 JavaTM编程语言编写的程序,它用 doclet API 指定 Javadoc 工具的输出内容和格式。
    • 缺省情况下,Javadoc 工具用 SunTM 提供的“标准”doclet 来生成 HTML 形式的 API 文档。
    • 然而,用户也可用自己的 doclet 根据个人喜好自定义 Javadoc 输出。用户可以利用 doclet API从头开始编写 doclet,也可以对标准 doclet 进行修改,以适合自己的需要。
  2. 自定义doclet基本步骤
    • 入门可参考 http://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/doclet/overview.html 
    • 编写用来构成 doclet 的 Java 程序。为使用 doclet API,该程序应导入 com.sun.javadoc.*。程序的入口点是一个带有 public static boolean start 方法的类,它将 RootDoc 作为参数。
    • 编译 doclet。可以使用 Java Development Kit 的编译器 javac 来编译它。
    • 用 -doclet <YourDoclet> 选项运行 javadoc 工具,生成 doclet 指定的输出。
    • doclet API 类文件在 JDK 软件的 lib/tools.jar 文件中。当编译 doclet 和使用自定义 doclet 时,tools.jar 必须在类路径上。为此,可以对 javac 和 javadoc 使用 -classpath 选项。
    • 包 com.sun.javadoc 由定义 doclet API 的接口组成。JDKTM 软件的 lib/tools.jar 文件包含这些接口及实现这些接口的类的私有包。tools.jar 文件还包括实现标准 doclet 的类。
  3. 深入了解
  4. 代码集成
  5. Bigger than bigger (比逼格更有逼格)
  6. 当然我这边也尝试写了一个工具wrdoclet,它可以针对restful的HTTP接口以及WebService接口生成接口文档,而不必暴露内部实现所用到的类。这样接口调用者可以很方便的参阅接口文档。wrdoclet的源码地址在github上: https://github.com/WinRoad-NET/wrdoclet 
此条目发表在Uncategorized分类目录,贴了, 标签。将固定链接加入收藏夹。