使用 Java 的注解处理器生成文档/XML 的实际示例答案

【问题标题】：Practical examples of generating documentation/XML with Java's annotation processors使用 Java 的注解处理器生成文档/XML 的实际示例
【发布时间】：2015-02-25 20:19:35
【问题描述】：

注释经常提到的优点之一是能够使用编译/部署时注释处理器生成文档、XML、配置文件等。我见过几个注释处理器的例子，但不是关于用它们自动生成文档或 XML。我可以明白为什么这很有用，例如从注释中将有价值的信息添加到项目的文档中。

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

所以，我的问题是：如何使用处理器为项目生成文档、配置、XML 文件，以及有哪些实际示例？

【问题讨论】：

@Documented 只是对任何文档工具的提示。有些注解对 API 很重要，有些则不重要，因此您可以决定在文档中包含 annotated 注解。哪个工具或该工具是否使用处理器并不重要。

标签： java annotations annotation-processing

【解决方案1】：

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

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

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

【讨论】：