Wie kann ich "<" und ">" in Javadoc ohne Formatierung verwenden?

120

Wenn ich <xmlElement>in einem Javadoc schreibe , wird es nicht angezeigt, da Tags spezielle Funktionen zum Formatieren von Texten haben.

Wie kann ich diese Zeichen in einem Javadoc anzeigen?

java javadoc

— Tom Brito
quelle

4

Verwandte, aber nicht ganz betrogen: stackoverflow.com/questions/1782040/…

— Pops

159

Sie können <für < und >für > verwenden .

— Pavitar Singh
quelle

oder Sie könnten & amp; um dem &

— ILMTitan

14

@TomBrito Obwohl dies die eigentliche Frage beantwortet, glaube ich, dass die Notwendigkeit, den Zeichen zu entkommen, nur dann auftritt, wenn sie als spitze Klammern (dh paarweise) verwendet werden, was wiederum impliziert, dass sie Teil eines Codes sind (z. B. eines XML-Tags). wie im Fall von OP). In dieser Situation glaube ich, dass eine bessere Lösung darin besteht, das gesamte XML-Snippet in {@code ...}Tags zu verpacken , wie Etienne Delavennat in seiner Antwort vorgeschlagen hat.

— Zoltán

&gt oder &lt hat nicht genau die gleiche Bedeutung wie die spitzen Klammern im XML-Format. Ist {@code <>}aber eine richtige Wahl.

— cinqS

63

Neuere Versionen von JavaDoc unterstützen {@literal A C}; Dadurch wird der Inhalt korrekt ausgegeben (wobei das '<' und '>' im generierten HTML-Code maskiert wird).

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

— Howard M. Lewis Schiff
quelle

41

Angesichts der Tatsache, dass XML tatsächlicher Code ist, sind XML-Snippets in Javadoc meiner Meinung nach besser für das Tag {@code A C} geeignet als für das Tag {@literal A C}.

Das Tag {@code} verwendet eine Schriftart mit fester Breite, die den Inhalt als tatsächlichen Code hervorhebt.

— Etienne Delavennat
quelle

2

Genau. XML sollte in {@code }Tags eingeschlossen werden. Es wird natürlicher angezeigt (mit einer Schriftart mit fester Breite) und sieht im Quell-Javadoc nicht sonderbar aus, da Sie die spitzen Klammern nicht separat umgehen müssen.

— Zoltán

15

Escape sie als HTML: <und>

— Duffymo
quelle

9

Sie müssen nur das HTML-Äquivalent für eine der spitzen Klammern verwenden. Das <kann entweder <oder dargestellt werden <. Hier ist ein Beispiel aus echtem Javadoc:

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

Dies wird angezeigt als:

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

— Pops
quelle

3

Wenn Sie maven so einrichten, dass Markdown verwendet wird , können Sie es einfach mit Backticks umgeben.

`AC` liest sich ein bisschen schöner als {@code AC}

— Owen
quelle

2

Das Einfügen von <pre> und {@code} speichert spitze Klammern und Leerzeilen in Javadocs und ist weit verbreitet, siehe beispielsweise java.util.Stream.

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— Serg
quelle

1

Umgib es einfach {@code}so:

{@code <xmlElement>}

— ivanjermakov
quelle