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

Question

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

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

Answer 1

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

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

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

This is an "at" symbol: @

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

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

Answer 2

Просто напишите это как HTML-сущность:

@

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

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

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

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

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

Answer 3

мое решение

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

* /

Answer 4

Вы получили общее представление, попробуйте использовать восьмеричное представление: @