首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >在JavaDoc中使用注释的代码示例

在JavaDoc中使用注释的代码示例
EN

Stack Overflow用户
提问于 2010-04-14 16:59:40
回答 4查看 14K关注 0票数 36

当我有一个带有注释的代码示例时,我的JavaDoc不工作。

有什么建议吗?

代码语言:javascript
复制
/**
 * <pre>
 * public class Demo {
 *    @DemoAnnotation
 *    public void demoMethod() {
 *    }
 * }
 * </pre>
 */ 
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {
EN

回答 4

Stack Overflow用户

回答已采纳

发布于 2010-04-14 17:03:35

您必须在JavaDoc中将@替换为&#064;

票数 35
EN

Stack Overflow用户

发布于 2018-07-13 18:29:12

像这样使用:

代码语言:javascript
复制
/**
 * <pre><code>
 *    public class Demo {
 *      @DemoAnnotation
 *      public void demoMethod() {
 *      }
 *    }
 * </code></pre>
 */ 

生成一个段落,而单独也可以内联使用。

票数 0
EN

Stack Overflow用户

发布于 2018-08-29 08:04:59

您也可以使用@code来转义注释,但您必须像这样逐个执行每个注释:

代码语言:javascript
复制
/**
 * <pre>
 * public class Demo {
 *   {@code @DemoAnnotation }
 *   {@code @AnotherAnnotation }
 *    public void demoMethod() {
 *    }
 * }
 * </pre>
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface DemoAnnotation {

将以如下方式呈现:

代码语言:javascript
复制
public class Demo {
    @DemoAnnotation
    @AnotherAnnotation
    public void demoMethod() {
    }
}

注意:简单地将两个注释或整个代码示例包装在一个@code块中是行不通的。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/2636086

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档