为外部库编写JavaDocs

Question

我的情况是我有一个没有JavaDocs的第三方的外部编译库(jar).在我正在开发时,我想通过测试和使用我从第三方网站获得的非常有限的文档来记录类和方法.

我的最终目标是获得一个JavaDoc文档,我可以在IntelliJ中使用它来进行代码提示和文档查找？

所以我的问题是,是否有可能将JavaDocs写入已编译的jar文件,我将能够导入？也许使用一种有助于此的工具.

Answer 1

是的。您所要做的就是写出类、接口、方法和变量定义，无需任何代码，就好像所有方法都是抽象的一样，然后为它们编写 Javadoc 注释。这实际上就是 Sun 生成 Javadoc 的方式，通过由技术作者和编辑（嗨 Doug！）控制的完全独立的源代码树，并在构建过程后期进行合并过程以发布源代码。