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

时间:2015-02-25 20:19:35

标签: java annotations annotation-processing

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

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

所以,我的问题是:如何使用处理器为项目生成文档,配置,XML文件,以及它的一些实际示例?

1 个答案:

答案 0 :(得分:1)

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

如果程序使用@Option注释,则其Javadoc包含其命令行选项的说明。以下是two examples

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