Как вы можете избежать символа @в javadoc?

Как я могу избежать символа @ в javadoc? Я пытаюсь использовать его внутри тега {@code}, который находится внутри тегов <pre>.

Я уже пробовал последовательность html escape &#64;, но это не сработало.

ОТВЕТЫ

Ответ 1

Используйте тег {@literal} javadoc:

/**
 * This is an "at" symbol: {@literal @}
 */

javadoc для этого будет читать:

This is an "at" symbol: @

Конечно, это будет работать для любых символов и является "официально поддерживаемым" способом отображения любых "специальных" символов.

Это также самое страшное - вам не нужно знать шестнадцатеричный код персонажа, и вы можете прочитать, что вы набрали!

Ответ 2

Просто напишите его как объект HTML:

&#064;

Из документа " javadoc - Генератор документации Java API"

Если вы хотите запустить строку с символом @и не интерпретировать ее, используйте объект HTML @.

Это означает, что вы можете использовать объекты HTML для любого символа, который вам нужно будет убежать, и действительно вы можете:

Текст должен быть написан в HTML с HTML-объектами и тегами HTML. Вы можете использовать любую версию HTML, поддерживаемую вашим браузером. Стандартный doclet генерирует HTML-совместимый код в другом месте (за пределами комментариев документации) с включением каскадных таблиц стилей и фреймов. HTML 4.0 является предпочтительным для сгенерированных файлов из-за наборов фреймов.

Например, объекты для символа меньше (<) и символ больше ( > ) должны быть записаны как &lt; и &gt;. Аналогично, амперсанд (&) должен быть записан как &amp;.

Ответ 3

Мое решение

/**
 * Mapper Test Helper.
 *
 * add the following annotations above the class
 * <pre>{@code
 * // junit5
 * @literal @ExtendWith(SpringExtension.class)
 * // junit4
 * @literal @RunWith(SpringRunner.class)
 * }</pre>
 */

Ответ 4

У вас есть общая идея, попробуйте использовать восьмеричное представление: &#064;