Заставить Javadoc игнорировать аннотацию - PullRequest
1 голос
/ 03 апреля 2009

Я пытаюсь задокументировать аннотированный интерфейс и включить пример того, как он используется в Javadoc. например,

/**
 * Here's an example usage:
 *
 * 
 * @IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     @MethodAnnotation("")
 *     public String Method();
 * }
 * 
* /

Однако Javadoc рассматривает мои аннотации как инструкции Javadoc (например, @param и т. Д.) И в результате выводит только:

Вот пример использования:

В сгенерированной документации. Единственный способ остановить это - добавить дополнительный символ перед аннотацией, например,

/**
 * Here's an example usage:
 *
 * 
 * \@IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     \@MethodAnnotation("")
 *     public String Method();
 * }
 * 
* /

но это выглядит немного грязно.

Просто подумал, есть ли у кого-нибудь предложения, спасибо.

Ответы [ 3 ]

2 голосов
/ 03 апреля 2009

Вы можете использовать '@' вместо @, но это еще страшнее.

0 голосов
/ 16 октября 2017

Для записи, правильный и полный ответ:

<code>/**
 * Here's an example usage:
 *
 * <pre>
 * {@code}
 * &#064;IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     &#064;MethodAnnotation("")
 *     public String Method();
 * }
 * 
* /

, что приводит к

enter image description here

0 голосов
/ 16 августа 2009

Вы пытались обернуть его в нотацию {@code}?

...