注释经常提到的优点之一是能够使用编译/部署时注释处理器生成文档、XML、配置文件等。我见过几个注释处理器的示例,但没有见过用它们自动生成文档或 XML 的示例。我明白为什么这会有用,例如通过注释向项目文档添加有值(value)的信息。
将它们包含在文档中的一种方法是对注释类型使用 @Documented
元注释,将它们包含在 JavaDoc 中,但它只是按原样复制注释及其值,而不会更改、格式化或生成任何内容。
所以,我的问题是:如何使用处理器为项目生成文档、配置、XML 文件,有哪些实际示例?
最佳答案
一个生成文档的注释处理器适用于 plume-lib的Options注释。
如果程序使用@Option
注释,则其Javadoc包含其命令行选项的描述。这里是two examples .
此外,程序的命令行选项会自动解析,并自动生成使用消息。因此,您只需编写一次文档;源代码、手册和使用消息始终保持同步。
关于java - 使用 Java 注释处理器生成文档/XML 的实际示例,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/28728815/