如何在不格式化的情況下在 javadoc 中使用“<”和“>”？

Question

如果我在 javadoc 中編寫<xmlElement> ，它不會出現，因為標簽對格式化文本具有特殊功能。

如何在 javadoc 中顯示此字符？

Answer 1

您可以使用< 對於<和> 為> 。

Answer 2

JavaDoc的最新版本支持{@literal A <B> C}; 這樣可以正確輸出內容（在生成的HTML中轉義“ <”和“>”）。

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

Answer 3

考慮到XML是實際代碼，我相信Javadoc中的XML代碼段比{@literal A <B> C}標簽更適合{@code A <B> C}標簽。

{@code}標記使用固定寬度的字體，該字體的內容作為實際代碼脫穎而出。

Answer 4

將它們轉為HTML： < 和>

Answer 5

您只需要對其中一個尖括號使用等效的HTML。 <可以表示為< 或< 。 這是從真實的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>

Answer 6

如果將maven設置為使用markdown ，則可以將其用反引號包圍。

`A<B>C`讀起來比{@code A<B>C}更好

Answer 7

插入<pre>和{@code}可以在Javadocs中保存尖括號和空行，並且被廣泛使用，例如，請參見java.util.Stream。

<pre>{@code
   A<B>C

   D<E>F
}</pre>

Answer 8

像這樣用{@code}包圍它：

{@code <xmlElement>}

Answer 9

在我想放入我的 javadocs List<SomeClass> ...

我通過提供指向我的SomeClass的鏈接添加了更具體的信息，所以這是我的解決方案：

List<{@link SomeClass}>

這導致了一個干凈的：

List<SomeClass>

帶有下划線的“SomeClass”指向指定的類。

（當然如果SomeClass不在同一個包中，則應引用完整路徑）