如何在我的 javadoc 示例中编写块注释？ [复制]

Question

所以我有一个看起来像这样的 javadoc（当然是为公众审查的）：

/**
 * Description of my method
 * <p>
 * <b>Example:</b>
 * </p>
 * <pre>
 * {@code
 * /**
 *  * Sample Javadoc
 *  *&#47;
 *  public final void testMyMethod()
 *  &#123;
 *      // some logic
 * &#125;}
 * </pre>
 * @return Description of my return value.
 */

所以这样做的原因是在我的示例中执行 */ 将结束 javadoc。有大括号会混淆@code 标签。

问题是生成的 javadoc 显示的是 HTML 实体代码，而不是我想向 javadoc 的使用者显示的实际字符。关于如何解决这个问题的任何想法？

Answer 1

不幸的是，没有真正的方法可以做到这一点（至少我不知道。）我过去一直被这个刺痛，这真的很烦人！

获得正确方法的两种解决方法（都不是很好）是：

• 关闭并重新打开代码标签以排除烦人的字符（这样做}/{@code）

• 完全抛弃{@code，只使用老式的<code> 标签。

就我个人而言，我更喜欢最后一种方法，因为它更简洁，并且（可能）更容易在修复后转换 - 但它并不理想。