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

120

如果我用<xmlElement>javadoc 编写，它不会出现，因为标签在格式化文本方面具有特殊功能。

如何在Javadoc中显示此字符？

java javadoc

— 汤姆·布里托
source

4

相关但不完全是骗子：stackoverflow.com/questions/1782040/…– 2010

— 流行

160

您可以使用<为<和>为>。

— 帕维尔塔·辛格（Pavitar Singh）
source

或者您可以使用＆amp; 逃脱＆

— ILMTitan，2010年

14

@TomBrito尽管这回答了实际的问题，但我相信只有当将符号用作尖括号（即成对使用）时，才有必要逃避这些符号，这反过来又暗示它们是某些代码（例如XML标记，就像OP的情况一样）。在这种情况下，我相信更好的解决方案是将整个XML代码段包装在{@code ...}标签中，如Etienne Delavennat在他的回答中所建议的。

— 佐尔坦

&gt或&lt与XML格式的尖括号不完全相同。但是{@code <>}是正确的选择。

— cinqS

63

JavaDoc的最新版本支持{@literal A C}; 这样可以正确输出内容（在生成的HTML中转义“ <”和“>”）。

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

— 霍华德·刘易斯·希普
source

41

考虑到XML是实际代码，我相信Javadoc中的XML代码段比{@literal A C}标签更适合{@code A C}标签。

{@code}标记使用一种固定宽度的字体，该字体的内容与实际代码一样突出。

— 艾蒂安·德拉文纳特（Etienne Delavennat）
source

2

我同意。XML应该包装在{@code }标签中。它会更自然地显示（使用固定宽度的字体），并且在源javadoc中看起来不会很奇怪，因为您不必单独转义尖括号。

— 佐尔坦

15

将它们转义为HTML：<和>

— 达菲
source

9

您只需将HTML等效项用于尖括号之一。的<可以表示为任一<或<。这是从真实的Javadoc中获取的示例：

<pre>
＆lt; complexType>
  ＆lt; complexContent>
    ＆lt; restriction base =“ {http://www.w3.org/2001/XMLSchema}anyType”>
      ＆lt;顺序>
      [...]

显示为：

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

— 流行音乐
source

3

如果将Maven设置为使用markdown，则可以将其用反引号包围。

`AC` 读起来比 {@code AC}

— 欧文
source

2

插入<pre>和{@code}可以在Javadocs中保存尖括号和空行，并且被广泛使用，例如，请参见java.util.Stream。

<pre>{@code
   A<B>C

   D<E>F
}</pre>

— 塞格
source

1

{@code}像这样围绕它：

{@code <xmlElement>}

— 伊万杰马科夫
source