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

2024-01-03

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

“${person}”部分破坏了文档注释,因为它使用花括号。


与其说是一个答案,不如说是一个解决方法,但如果你更换{@code ...}与旧版本<code>...</code>它会按照您的预期呈现大括号。

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

不幸的是,这会破坏尖括号,因此对于最初的问题,您需要转义这些:

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

您甚至可以在这里作弊,让 Notepad++ 为您执行此操作,使用方便的 TextFX -> 转换 -> 编码 HTML (&")。

这样做至少有一个好处,即所有内容在生成的 Javadoc 和 Eclipse 的 Javadoc 视图中都可以很好地呈现,这似乎无法理解&#125;和朋友。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何转义 javadoc 内联标记中的花括号,例如 {@code} 标记 的相关文章

随机推荐