使用 Java 的注释处理器生成 documentation/XML 的实际示例

Question

注解经常提到的优点之一是能够使用 compile/deployment-time 注释处理器生成文档、XML、配置文件等。我看过几个注释处理器的例子，但没有看到关于自动生成文档或 XMLs 的例子。我明白为什么这会有用，例如从注释中向项目文档添加有价值的信息。

将它们包含在文档中的一种方法是对注释类型使用 @Documented 元注释以将它们包含在 JavaDoc 中，但它只是按原样复制注释及其值，而不更改、格式化或生成任何内容。

所以，我的问题是：处理器如何用于为项目生成文档、配置、XML 文件，这方面的一些实际示例是什么？

Answer 1

一个生成文档的注释处理器用于 plume-lib's Options 注释。

如果程序使用 @Option 注释，则其 Javadoc 包含对其命令行选项的描述。这里是 two examples.

此外，程序的命令行选项会自动解析，并自动生成用法消息。因此，您只需编写一次文档；源代码、手册和使用信息始终保持同步。