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

【问题标题】：How can I use "<" and ">" in javadoc without formatting?如何在没有格式化的情况下在 javadoc 中使用“<”和“>”？
【发布时间】：2011-02-23 08:13:03
【问题描述】：

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

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

【问题讨论】：

【解决方案1】：

您可以将&lt; 用于 和&gt; 用于>。

【讨论】：

或者你可以使用 & to 转义 &
@TomBrito 虽然这回答了实际问题，但我相信只有在将符号用作尖括号（即成对）时才会出现转义符号的必要性，这反过来意味着它们是某些符号的一部分代码（例如 XML 标记，如 OP 的情况）。在这种情况下，我相信更好的解决方案是将整个 XML sn-p 包装在 {@code ...} 标记中，正如 Etienne Delavennat 在他的回答中所建议的那样。
&gt 或 &lt 与 XML 格式的尖括号的含义并不完全相同。但是{@code <>} 是一个正确的选择。

【解决方案2】：

JavaDoc 的最新版本支持 {@literal AC};这会正确输出内容（在生成的 HTML 中转义 ''）。

【讨论】：

【解决方案3】：

考虑到 XML 是实际代码，我相信 Javadoc 中的 XML sn-ps 更适合 {@code AC} 标签而不是 {@literal AC} 标签。

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

【讨论】：

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

【解决方案4】：

将它们转义为 HTML：&lt; 和 &gt;

【讨论】：

【解决方案5】：

您只需对其中一个尖括号使用 HTML 等效项。 &lt; 可以表示为&lt; 或&#60;。下面是一个取自真实 Javadoc 的示例：

<restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> [...]

这显示为：

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

【讨论】：

【解决方案6】：

和{@code}的插入节省了javadocs中的尖括号和空行，被广泛使用，例如见java.util.Stream。

<pre>{@code
   A<B>C

   D<E>F
}</pre>

【讨论】：

【解决方案7】：

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

{@code <xmlElement>}

【讨论】：

【解决方案8】：

如果你是set maven up to use markdown，你可以用反引号括起来。

`A<B>C` 读起来比 {@code A<B>C} 好一点

【讨论】：

【解决方案9】：

就我而言，我想输入我的 javadocs List<SomeClass>...

我通过提供指向我的SomeClass 的链接添加了更具体的信息，所以这是我的解决方案：

List<{@link SomeClass}>

这导致了一个干净的：

List<SomeClass>

带有下划线的“SomeClass”指向指定的类。

（当然如果SomeClass不在同一个包中，要参考完整路径）

【讨论】：