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

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?

Możesz użyć <dla < i >dla > .

Najnowsze wersje obsługi JavaDoc {@literal A <B> C}; Powoduje to prawidłowe wyświetlanie treści (z ucieczką znaków „<” i „>” w wygenerowanym kodzie HTML).

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

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.

Pomiń je jako HTML: <i>

Wystarczy użyć odpowiednika HTML dla jednego z nawiasów ostrych. <Może być przedstawiony jako <lub <. 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>

Jeśli ustawisz mavena, aby używał przeceny , możesz po prostu otoczyć go grawitacjami.

`A<B>C` czyta się trochę ładniej niż {@code A<B>C}

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>

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

{@code <xmlElement>}