强制javadoc忽略注释

Question

我正在尝试记录带注释的界面，并在javadoc中包含一个如何使用它的示例。 e.g。

/**
 * 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

对于记录，正确和完整的答案是：

groceries = ['eggs', 'bacon', 'milk']
grocery_prices = [4.99, 6.99, 2.99]

def price_sub_list(items, prices, low, high) :
    new_price_list = prices.remove([low:])
    new_price_list = prices.remove([:high])
    new_list = items.remove(['''equivalent of <low''']:)
    new_list = items.remove(:['''equivalent of >high'''])
    print(new_list)

price_sub_list(groceries, grocery_prices, 3, 5)

导致