当我有一个带有注释的代码示例时，我的 JavaDoc 不起作用。
有什么建议吗？
/**
* <pre>
* public class Demo {
* @DemoAnnotation
* public void demoMethod() {
* }
* }
* </pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {
【问题讨论】：
更通用的解决方案：{@literal @}
{@literal}标签表示文字文本。包含的文本被解释为不包含 HTML 标记或嵌套的 javadoc 标记。例如，文档注释文本：{@literal a<B>c}在生成的 HTML 页面中显示不变：a<B>c——即<B>不会被解释为粗体。
需要 Java 5+
【讨论】：
{@literal @} 在@ 之前添加了一个难看的空间（至少在NetBeans 中查看时）。 &#064; 没有（例如，它在 JUnit javadoc 中使用）。哦，并且它在 @code 内部不起作用（&#064; 起作用）。
@code 行为是设计使然；有关如何在 javadoc 中嵌入复杂代码 sn-ps 的良好提示，请参阅此答案：stackoverflow.com/a/13512524/159570
中尝试了带有注释的代码，并且 {@literal @} 在输出中添加了一个前导空格（Java 9）。我选择了丑陋的 HTML 实体。这在 {@code } 块中不起作用。似乎没有通用的好方法如何将代码逐字插入 Javadoc 而无需转义。
您必须在 JavaDoc 中将 @ 替换为 &#064;。
【讨论】：
像这样使用 ：
/**
* <pre><code>
* public class Demo {
* @DemoAnnotation
* public void demoMethod() {
* }
* }
* </code></pre>
*/
产生一个段落，而 单独也可以内联使用。
【讨论】：
你也可以使用@code 来转义注解，但是你必须像这样单独做每一个：
/**
* <pre>
* public class Demo {
* {@code @DemoAnnotation }
* {@code @AnotherAnnotation }
* public void demoMethod() {
* }
* }
* </pre>
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {
会这样渲染：
public class Demo {
@DemoAnnotation
@AnotherAnnotation
public void demoMethod() {
}
}
注意：将两个注解（或整个代码示例）简单地包装在一个 @code 块中是行不通的。
【讨论】：
您必须使用@Documented 注释在javadoc 中添加注释。检查 API 上的实现
【讨论】：