Как я могу использовать «<» и «>» в ​​javadoc без форматирования?

121

Если я пишу <xmlElement>в javadoc, он не отображается, потому что теги имеют специальные функции по форматированию текста.

Как я могу показать эти символы в javadoc?

java javadoc Том Брито
источник
4
Связано, но не совсем обман: stackoverflow.com/questions/1782040/…
Pops

Ответы:

160

Вы можете использовать &lt;для < и &gt;для > .

Павитар Сингх
источник
или вы можете использовать & amp; чтобы убежать от &
ILMTitan
14
@TomBrito Хотя это отвечает на фактический вопрос, я считаю, что необходимость избегать знаков появляется только тогда, когда они используются в качестве угловых скобок (то есть в парах), что, в свою очередь, подразумевает, что они являются частью некоторого кода (например, тега XML, как в случае с OP). В этой ситуации я считаю, что лучшим решением будет обернуть весь XML-фрагмент {@code ...}тегами, как предложил Этьен Делавенна в своем ответе.
Zoltán
&gtили &ltзначение угловых скобок в формате XML отличается. Но {@code <>}это правильный выбор.
cinqS 06
41

Учитывая, что XML - это реальный код, я считаю, что фрагменты XML в Javadoc лучше подходят для тега {@code A <B> C}, чем для тега {@literal A <B> C}.

В теге {@code} используется шрифт фиксированной ширины, благодаря чему его содержание выделяется как фактический код.

Этьен Делавенна
источник
2
Я согласен. XML должен быть заключен в {@code }теги. Он будет отображаться более естественно (с шрифтом фиксированной ширины) и не будет выглядеть странно в исходной документации javadoc, потому что вам не нужно отдельно выходить из угловых скобок.
Zoltán
15

Экранировать их как HTML: &lt;и&gt;

duffymo
источник
9

Вам нужно только использовать эквивалент HTML для одной из угловых скобок. <Может быть представлена в виде либо &lt;или &#60;. Вот образец, взятый из настоящего Javadoc:

<Предварительно>
& Lt; ComplexType>
  & Lt; complexContent>
    & lt; Restriction base = "{http://www.w3.org/2001/XMLSchema}anyType">
      & Lt; последовательности>
      [...]

Это отображается как:

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
попса
источник
3

Интерпретация <pre> и {@code} сохраняет угловые скобки и пустые строки в документации javadocs и широко используется, см. Например java.util.Stream.

<pre>{@code
   A<B>C

   D<E>F
}</pre>
Serg
источник
1

Просто окружите его {@code}вот так:

{@code <xmlElement>}
ivanjermakov
источник