Як можна уникнути символу @ у javadoc?


180

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

Я вже пробував html &#64;послідовність виходу , але це не спрацювало.


Тепер він почав відображатися прекрасно після того, як я відкоригував частину відступів усередині блоку @ {code}! Це було в Eclipse, якщо це має значення.
JayL

Я досі не можу змусити його працювати
Ніл Бенн

Відповіді:


267

Використовуйте {@literal}тег javadoc:

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

Явадок для цього буде читати:

This is an "at" symbol: @

Звичайно, це буде працювати для будь-яких персонажів, і це "офіційно підтримуваний" спосіб відображення будь-яких "спеціальних" символів.

Це також найяскравіше - вам не потрібно знати шістнадцятковий код символу, і ви можете прочитати те, що ви ввели!


1
Як уникнути }символу?
ADTC

1
@ADTC Ви не можете. Чому б ви хотіли? }не має особливого значення в html.
богем

Тож я думаю, ви можете розділити його лише на два literalтеги.
ADTC

23
Я здивований, що це прийнято, і так підняли голос. Примітка питання: всередині тегу {@code} . {@literal} просто не працює всередині тега {@code}.
Даніель К. Собрал

6
Пропускання {та просто використання @literal @робіт усередині {@code}тегу.
Бред Турек

55

Просто напишіть це як сутність HTML:

&#064;

З документа " javadoc - генератор документації Java API "

Якщо ви хочете почати рядок із символом @ і не інтерпретувати його, використовуйте сутність HTML @.

Це означає, що ви можете використовувати сутності HTML для будь-якого символу, який вам знадобиться втекти, і дійсно ви можете:

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

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


Це працює краще, ніж буквальний вираз, коли не супроводжується пробілом (наприклад, при написанні анотації)
Bludwarf

8

моє рішення таке

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

Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.