如何在 javadoc 中使用“ <”和“ >”而不进行格式化？

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

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

56717 次浏览
小开

以 HTML: &lt;和 &gt;的形式转义它们

小开

您只需要对其中一个尖括号使用 HTML 等价物。<可以表示为 &lt;或 &#60;。下面是从真正的 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>
小开
最佳答案

您可以使用 &lt;作为 < ，使用 &gt;作为 >。

小开

最新版本的 JavaDoc 支持{@LiteralA < B > C } ; 这将正确输出内容(在生成的 HTML 中转义’<’和’>’)。

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

小开

考虑到 XML 是实际的代码，我认为 Javadoc 的 XML 片段更适合于{@code a < B > C }标记，而不是{@Literal a < B > c }标记。

{@code }标记使用固定宽度的字体，使其内容作为实际代码脱颖而出。

小开

如果你的 设置标记使用标记，你可以只是围绕它与反勾。

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

小开

< pre > 和{@code }的介入在 javadocs 中保存了尖括号和空行，并被广泛使用，请参见 java.util。比如说数据流。

<pre>{@code
A<B>C


D<E>F
}</pre>
小开

像这样用 {@code}环绕它:

{@code <xmlElement>}
小开

在我的情况下，我想把我的 javadocs List<SomeClass>..。

我添加了一个更具体的信息给我的 SomeClass链接，所以这里是我的解决方案:

List<{@link SomeClass}>

结果是:

List<SomeClass>

带下划线的“ Some Class”指向指定的类。

(当然，如果 SomeClass不在同一个包中，应该引用完整的路径)


提交答案