Страницы

Поиск по вопросам

вторник, 23 апреля 2019 г.

Форматирование текста в документации к Java методам/классам - отображение дженериков

Дано:
Пытаюсь добаваить к описанию класса в конструкции
/** * */
строку
ArrayList
но отображается (как и тут, в цитате):
ArrayList
Пробовал эти варианты:
Экранирование
ArrayList<\String>
получилось:
ArrayList\String>
Больше экранирования:
ArrayList\<\String>
получилось:
ArrayList\ \String>
Оборачивание тегом
ArrayList
ничего не выходит:
ArrayList


Ответ

Старый метод: ArrayList<String>.
Современный поход (начиная с JDK 1.5): использовать теги @literal или @code
при этом надо обернуть тег и его содержимое фигурными скобками
При использовании первого тега содержимое внутри не будет рассматриваться как HTML разметка (например, удобно для описания математических выражений). Второй тег используется для обертки кода.

Комментариев нет:

Отправить комментарий