如何在没有格式化的情况下在javadoc中使用"<"和">"？

Question

如果我<xmlElement>在javadoc中写入,则不会出现,因为标签在格式化文本时具有特殊功能.

如何在javadoc中显示这些字符？

Answer 1

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

@TomBrito虽然这回答了实际的问题,但我认为只有当它们被用作尖括号(即成对)时才会出现逃避符号的必要性,这反过来暗示它们是某些代码的一部分(例如XML标记,如在OP的情况下).在这种情况下,我认为更好的解决方案是将整个XML片段包装在`{@code ...}`标签中,正如Etienne Delavennat在他的回答中所建议的那样. (13认同)
`>` 或 `<` 与 XML 格式中的尖括号的含义并不完全相同。但 `{@code <>}` 是一个正确的选择。 (2认同)

Answer 2

最新版本的JavaDoc支持{@literal A <B> C}; 这会正确输出内容(在生成的HTML中转义'<'和'>').

Answer 3

考虑到XML是实际代码,我相信Javadoc中的XML片段更适合{@code A <B> C}标记而不是{@literal A <B> C}标记.

{@code}标记使用固定宽度字体,使其内容成为实际代码.

我同意.XML应该包含在`{@code}`标签中.它将更自然地显示(使用固定宽度的字体),并且在源javadoc中看起来不会很奇怪,因为您不必单独转义尖括号. (2认同)

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

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

<pre>{@code
   A<B>C

   D<E>F
}</pre>

Answer 7

就像这样包围它{@code}：

{@code <xmlElement>}