JavaDoc中带注释的代码示例

Joh*_*ohn 35 java javadoc

当我有一个带注释的代码示例时,我的JavaDoc不起作用.

有什么建议?

/**
 * <pre>
 * public class Demo {
 *    @DemoAnnotation
 *    public void demoMethod() {
 *    }
 * }
 * </pre>
 */ 
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {
Run Code Online (Sandbox Code Playgroud)

Joe*_*der 53

更通用的解决方案: {@literal @}

{@literal}标签是指文字文本.随附的文本被解释为不包含HTML标记或嵌套的javadoc标记.例如,doc注释文本:{@literal a<B>c}在生成的HTML页面中不变地显示:a<B>c- 也就是说,<B>不会将其解释为粗体.

需要Java 5+

  • 恕我直言,这应该是公认的答案. (3认同)
  • 在实际尝试之前对它进行了提升,但后来我发现了一个问题:使用`@@literal @}`在`@`之前添加了一个丑陋的空间(至少在NetBeans中查看时).`&#064;`没有(例如,它在JUnit javadoc中使用).哦,*和*它在`@ code`(`&#064;`确实)中不起作用. (2认同)

Esp*_*pen 33

您必须更换@&#064;在JavaDoc的.