Как я могу использовать "<" и ">" в Javadoc без форматирования? - PullRequest
Новая
       17

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

103 голосов
/ 24 мая 2010

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

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

Ответы [ 6 ]

142 голосов
/ 24 мая 2010

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

60 голосов
/ 18 мая 2011

Последние версии поддержки JavaDoc {@literal A C};это выводит содержимое правильно (экранируя '<' и '>' в сгенерированном HTML).

См. http://download.oracle.com/javase/1.5.0/docs/guide/javadoc/whatsnew-1.5.0.html

38 голосов
/ 22 января 2015

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

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

14 голосов
/ 24 мая 2010

Escape их как HTML: &lt; и &gt;

9 голосов
/ 24 мая 2010

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

<pre>
&lt;complexType>
  &lt;complexContent>
    &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
      &lt;sequence>
      [...]

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

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
2 голосов
/ 22 февраля 2017

Если вы настроили maven на использование уценки , вы можете просто заключить его в кавычки.

`A<B>C` читает немного лучше, чем {@code A<B>C}

...