使用Java';s注释处理器

使用Java';s注释处理器,java,annotations,annotation-processing,Java,Annotations,Annotation Processing,注释的一个经常提到的优点是能够使用编译/部署时注释处理器生成文档、XML、配置文件等。我见过几个注释处理器的示例,但没有介绍如何使用它们自动生成文档或XML。我可以理解为什么这会有用,例如,从注释中向项目文档添加有价值的信息 将它们包含在文档中的一种方法是使用注释类型上的@Documented元注释将它们包含在JavaDoc中,但它只复制注释及其值,而不更改、格式化或生成任何内容 所以,我的问题是:如何使用处理器为项目生成文档、配置和XML文件,以及这方面的一些实际示例是什么 一个生成文档的注释

注释的一个经常提到的优点是能够使用编译/部署时注释处理器生成文档、XML、配置文件等。我见过几个注释处理器的示例,但没有介绍如何使用它们自动生成文档或XML。我可以理解为什么这会有用,例如,从注释中向项目文档添加有价值的信息

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


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

一个生成文档的注释处理器用于的注释

如果程序使用
@选项
注释,则其Javadoc包含其命令行选项的描述。给你


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

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