如何在我的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>标签。

就我个人而言，我赞成最后一种方法，因为它有点整洁，并且（大概）以后如果修复程序到达时更容易转换 - 但它并不理想。