java - 将 Java 类文档从代码读取到 GUI 中

Question

我今天的问题是我有一个可以连接另一个程序的 GUI。我的 GUI 中有一个文本区域，我想在其中显示用户选择的特定组件的类文档。

示例:用户选择“协议(protocol)”设置，我希望它显示该“协议(protocol)”的 JavaDoc。

如何识别正确的 Javadoc 并将其显示在文本区域中？

Answer 1

我建议 3 种可能的方法:

• 作为构建的一部分，正常创建 Javadoc HTML，然后将其包含在可部署的文件中，并让 GUI 使用某种嵌入式浏览器(例如 WebKit)
• 研究其他 GUI 是如何完成此操作的，例如通过 Eclipse 的 Javadoc View，或使用 a project which extends Eclipse Javadoc View
• 使用 Java 源代码 (Javadoc) parsing library / tool ，如QDox

来自 QDox 的示例代码:

JavaDocBuilder builder = new JavaDocBuilder();
builder.addSource(new FileReader("MyFile.java"));