Як я можу використовувати "<" і ">" в javadoc без форматування?

121

Якщо я пишу <xmlElement>в javadoc, він не з’являється, оскільки теги мають спеціальні функції щодо форматування текстів.

Як я можу показати цю ознаку в javadoc?

java javadoc

— Том Бріто
джерело

4

Пов’язаний, але не зовсім обов`язковий: stackoverflow.com/questions/1782040/…

— Pops

160

Ви можете використовувати <для < і >для > .

— Павітар Сінгх
джерело

або ви можете використовувати & amp; щоб врятуватися &

— ILMTitan

14

@TomBrito Хоча це відповідає на власне питання, я вважаю, що необхідність уникнути знаків з'являється лише тоді, коли вони використовуються як кутові дужки (тобто парами), що, в свою чергу, означає, що вони є частиною якогось коду (наприклад, тег XML, як у випадку з ОП). В цій ситуації, я вважаю, що кращим рішенням буде загортати весь фрагмент XML у {@code ...}теги, як запропонував Етьєн Делавеннат у своїй відповіді.

— Золтан

&gtабо &ltне зовсім збігається з кутовими дужками у форматі XML. Але {@code <>}це правильний вибір.

— cinqS

63

Останні версії підтримки JavaDoc {@literal A C}; це виводить вміст правильно (уникаючи '<' і '>' в створеному HTML).

Дивіться http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

— Говард М. Льюїс Корабель
джерело

41

Зважаючи на те, що XML є фактичним кодом, я вважаю, що фрагменти XML у Javadoc краще підходять для тегу {@code A C}, а не для тега {@literal A C}.

Тег {@code} використовує шрифт фіксованої ширини, що робить його вміст виділеним фактичним кодом.

— Етьєн Делавеннат
джерело

2

Я згоден. XML слід загортати в {@code }теги. Він буде відображатися більш природним чином (з шрифтом фіксованої ширини), і він не виглядатиме дивно в джерелі javadoc, тому що вам не доведеться уникати кутових дужок окремо.

— Золтан

15

Уникніть їх як HTML: <і>

— duffymo
джерело

9

Вам потрібно використовувати лише HTML-еквівалент для одного з кутових дужок. Кан <може бути представлений як <або <. Ось зразок, взятий з реального Javadoc:

<pre>
& lt; complexType>
  & lt; complexContent>
    & lt; обмеження base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & послідовність>
      [...]

Це відображається як:

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>

— Попс
джерело

3

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

`AC` читає трохи приємніше, ніж {@code AC}

— Оуен
джерело

2

Розміщення <pre> і {@code} зберігає кутові дужки та порожні рядки в javadocs і широко використовується, див., Наприклад, java.util.Stream.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Серг
джерело

1

Просто оточіть його {@code}таким чином:

{@code <xmlElement>}

— ivanjermakov
джерело