Практические примеры генерации документации/XML с обработчиками аннотаций Java

Question

Одним из часто упоминаемых преимуществ аннотаций является возможность генерации документации, XML, файлов конфигурации и т. Д. С помощью компиляторов/приложений для аннотаций. Я видел несколько примеров обработчиков аннотаций, но не о том, чтобы автоматически создавать с ними документы или XML. Я могу понять, почему это было бы полезно, например. добавив ценную информацию в документацию проекта из аннотаций.

Один из способов включения их в документацию - использовать мета-аннотацию @Documented для типов аннотаций, чтобы включить их в JavaDoc, но просто копирует аннотацию с ее значениями, как есть, без изменения, форматирования или генерации чего-либо ,

Итак, мой вопрос: как можно использовать процессоры для генерации документации, конфигурации, XML-файлов для проекта и каковы некоторые практические примеры этого?

Answer 1

Один обработчик аннотации, который создает документацию, предназначен для plume-libOptions аннотация.

Если программа использует аннотацию @Option, ее Javadoc содержит описание параметров командной строки. Вот twoexamples.

Кроме того, параметры командной строки программы автоматически анализируются и автоматически генерируется сообщение об использовании. Таким образом, вам нужно только один раз написать документацию; исходный код, руководство и сообщения об использовании всегда остаются в синхронизации.