强制 javadoc 忽略注释

Question

我正在尝试记录一个带注释的接口，并在 javadoc 中包含一个关于它如何使用的示例。 例如

/**
 * Here's an example usage:
 *
 * <PRE>
 * @IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     @MethodAnnotation("")
 *     public String Method();
 * }
 * </PRE>
 */

但是，Javadoc 将我的注释视为 javadoc 指令（如 @param 等），因此只打印：

这是一个示例用法：

在生成的文档中。 我能够阻止这种情况的唯一方法是在注释之前添加一个额外的字符，例如

/**
 * Here's an example usage:
 *
 * <PRE>
 * \@IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     \@MethodAnnotation("")
 *     public String Method();
 * }
 * </PRE>
 */

但这看起来有点乱。

只是想知道是否有人有任何建议，谢谢。

Answer 1

您可以使用'@' 而不是@，但那更难看。

Answer 2

您也可以使用{@literal @} 。 没有讨厌的转义字符。

/**
 * Here's an example usage:
 *
 * <PRE>
 * {@literal @}IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     {@literal @}MethodAnnotation("")
 *     public String Method();
 * }
 * </PRE>
 */

Answer 3

你有没有试过用 {@code} 符号包装它？

Answer 4

为了记录，正确和完整的答案是：

/**
 * Here's an example usage:
 *
 * <pre>
 * {@code}
 * &#064;IFaceAnnotation(value="")
 * public interface IFace {
 *
 *     &#064;MethodAnnotation("")
 *     public String Method();
 * }
 * </pre>
 */

这导致