Jak mogę używać znaków „<” i „>” w javadoc bez formatowania?

121

Jeśli piszę <xmlElement>w javadoc, to się nie pojawia, ponieważ tagi mają specjalne funkcje w formatowaniu tekstów.

Jak mogę pokazać te znaki w javadoc?

java javadoc Tom Brito
źródło
4
Powiązane, ale niezbyt udane: stackoverflow.com/questions/1782040/ ...
Pojawia się

Odpowiedzi:

160

Możesz użyć &lt;dla < i &gt;dla > .

Pavitar Singh
źródło
lub możesz użyć & amp; uciec przed &
ILMTitan
14
@TomBrito Chociaż to odpowiada na rzeczywiste pytanie, uważam, że konieczność ucieczki przed znakami pojawia się tylko wtedy, gdy są one używane jako nawiasy kątowe (tj. W parach), co z kolei oznacza, że ​​są one częścią jakiegoś kodu (np. jak w przypadku OP). W tej sytuacji uważam, że lepszym rozwiązaniem jest zawinięcie całego fragmentu XML w {@code ...}znaczniki, jak zasugerował Etienne Delavennat w swojej odpowiedzi.
Zoltán
&gtlub &ltnie ma dokładnie tego samego znaczenia z nawiasami ostrymi w formacie XML. Ale {@code <>}to dobry wybór.
cinqS
41

Biorąc pod uwagę, że XML to rzeczywisty kod, uważam, że fragmenty XML w Javadoc lepiej pasują do tagu {@code A <B> C} niż do tagu {@literal A <B> C}.

Tag {@code} używa czcionki o stałej szerokości, dzięki czemu jego treść wyróżnia się jako rzeczywisty kod.

Etienne Delavennat
źródło
2
Zgadzam się. XML powinien być opakowany w {@code }tagi. Będzie wyświetlany bardziej naturalnie (z czcionką o stałej szerokości) i nie będzie wyglądał dziwnie w źródłowym javadoc, ponieważ nie musisz osobno wychodzić z nawiasów ostrych.
Zoltán
15

Pomiń je jako HTML: &lt;i&gt;

duffymo
źródło
9

Wystarczy użyć odpowiednika HTML dla jednego z nawiasów ostrych. <Może być przedstawiony jako &lt;lub &#60;. Oto próbka pobrana z prawdziwego Javadoc:

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

Wyświetla się jako:

<complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
Wyskakuje
źródło
2

Interpozycja <pre> i {@code} zapisuje nawiasy ostre i puste linie w javadocs i jest szeroko stosowana, patrz na przykład java.util.Stream.

<pre>{@code
   A<B>C

   D<E>F
}</pre>
Serg
źródło
1

Po prostu otocz go w {@code}ten sposób:

{@code <xmlElement>}
ivanjermakov
źródło