我怎么能用“＆lt;”和“＆gt;”在没有格式化的javadoc？

Question

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

如何在javadoc中显示此字符？

Answer 1

您可以将<用于＆lt; ，将>用于＆gt; 。

Answer 2

最近版本的JavaDoc支持{@literal A＆lt; B＆gt; C};这会正确输出内容（在生成的HTML中转义'＆lt;'和'＆gt;'）。

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

Answer 3

考虑到XML是实际代码，我相信Javadoc中的XML片段更适合{@code A＆lt; B＆gt; C}标记而不是{@literal A＆lt; B＆gt; 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

只需用{@code}包围它，像这样：

{@code <xmlElement>}

Answer 7

插入

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


<pre>{@code
   A<B>C

   D<E>F
}</pre>