Практические примеры создания документации/XML с помощью процессоров аннотаций Java

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

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

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


person spqpad    schedule 25.02.2015    source источник
comment
@Documented — это просто подсказка для любых инструментов документирования. Некоторые аннотации важны для API, некоторые нет, поэтому вы можете включить аннотацию annotated в документы. На самом деле не имеет значения, какой инструмент или использует ли инструмент процессор или нет.   -  person kapex    schedule 04.03.2015


Ответы (1)


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

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

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

person mernst    schedule 26.02.2015