Пример кода с аннотацией в JavaDoc

Question

мой JavaDoc не работает, когда у меня есть пример кода с аннотацией.

Есть предложения?

<code>/**
 * <pre>
 * public class Demo {
 *    @DemoAnnotation
 *    public void demoMethod() {
 *    }
 * }
 * 

* / @Retention (RetentionPolicy.RUNTIME) @Target ({ElementType.METHOD}) public @interface DemoAnnotation {

Answer 1

Более общее решение: {@literal @}

Тег {@literal} обозначает буквальный текст. Прилагаемый текст интерпретируется как не содержащий HTML-разметки или вложенных тегов Javadoc. Например, текст комментария к документу: {@literal a<B>c} отображается на сгенерированной HTML-странице без изменений: a<B>c - то есть <B> не интерпретируется как жирный.

Требуется Java 5 +

Answer 2

Вы должны заменить @ на @ в вашем JavaDoc.

Answer 3

Вы также можете использовать @code для экранирования аннотации, но вы должны сделать каждую по отдельности так:

<code>/**
 * <pre>
 * public class Demo {
 *   {@code @DemoAnnotation }
 *   {@code @AnotherAnnotation }
 *    public void demoMethod() {
 *    }
 * }
 * 

* / @Retention (RetentionPolicy.RUNTIME) @Target ({ElementType.METHOD}) public @interface DemoAnnotation {

будет отображаться так:

public class Demo {
    @DemoAnnotation
    @AnotherAnnotation
    public void demoMethod() {
    }
}

Примечание: не удастся просто обернуть обе аннотации или весь пример кода в один блок @code.

Answer 4

использование like this:</p> <pre><code>/** * <pre><code> * public class Demo { * @DemoAnnotation * public void demoMethod() { * } * } * * /

создает абзац, в то время как один также может использоваться встроенным.

Answer 5

Вы должны использовать аннотацию @Documented для добавления аннотаций в Javadoc. Проверьте реализацию по API