如何在javadoc内联标记中转义花括号,例如{@code}标记

Question

/**
 * Gets the meatball icon for a nincompoop.
 * 
 * <p>
 * Example: {@code <custom:meatball color="<%= Meatball.RED %> nincompoop="${person}" />}
 * 
 * @author King Cong
 * 
 */

"$ {person}"部分会破坏文档注释,因为它使用花括号.

Answer 1

作为一种解决方法,答案并非如此,但如果您{@code ...}使用旧版本进行替换,<code>...</code>它将呈现您期望的花括号.

<code>{person} == ${person}</code>

不幸的是,这打破了尖括号,所以对于原始问题,你需要逃避这些:

<code>&lt;custom:meatball color="&lt;%= Meatball.RED %&gt; nincompoop="${person}" /&gt;</code>

您甚至可以通过让Notepad ++为您做到这一点来欺骗,方便的TextFX - >转换 - >编码HTML(&<>").

这至少有一个好处,一切都可以在生成的Javadoc和Javadoc视图中的Eclipse中很好地呈现,而Javadoc视图似乎无法理解}和朋友.

Answer 2

尝试使用HTML转义:

${person} == ${person}

Answer 3

bodunbodun解决方案的工作原理通常发生在javadocs中也有换行符.如果你想要{和换行符',HTML转义将不起作用

<pre>
{@code
<foo bar="}${bar}{@code"/>
<bar foo="}${foo}{@code"/>
}
</pre>

会给你

<foo bar="${bar}" />
<bar foo="${foo}" />