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

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

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

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

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

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

This is an "at" symbol: @

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

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

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

@

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

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

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

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

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

мое решение

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

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