为外部库编写JavaDocs

时间:2017-06-26 10:43:32

标签: java intellij-idea javadoc

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

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

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

1 个答案:

答案 0 :(得分:4)

是的。您所要做的就是写出类和接口,方法和变量定义,,无需任何代码,就像所有方法都是抽象的一样,然后为这些方法编写Javadoc注释。这实际上是Sun通过一个完全独立的源代码树生成Javadoc的方式,这个源代码树由技术编写者和编辑控制(嗨Doug!),在构建过程的后期用于发布源代码的合并过程。