为外部库编写 JavaDocs

Question

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

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

所以我的问题是，是否可以将 JavaDocs 写入我将能够导入的已编译的 jar 文件？也许使用辅助工具。

Answer 1

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