为外部库编写JavaDocs

Question

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

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

因此，我的问题是，是否可以将JavaDocs写入已编译的jar文件，以便我能够导入该文件？也许可以使用一种工具来帮助这一点。

Answer 1

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