2009-07-22 6 views
17

В моем проекте мы используем ряд аннотаций, которые были бы очень полезны для просмотра в документации API javadoc.Есть ли способ получить инструмент javadoc для документирования аннотаций?

Кто-нибудь знает простой способ включения аннотаций в созданные javadocs? Я не хочу писать свой собственный плагин javadoc. Есть ли какие-то решения?

ответ

25

См java.lang.annotation.Documented

Указывает, что аннотации с типом должны быть задокументированы Javadoc и аналогичных инструментов по умолчанию. Этот тип должен использоваться для аннотирования деклараций типов, аннотации которых влияют на использование аннотированных элементов их клиентами. Если объявление типа аннотируется с Documented, его аннотации становятся частью публичного API аннотированных элементов.

Пример:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
} 
Смежные вопросы