如何评论enum使checkstyle快乐？

这是代码：如何评论enum使checkstyle快乐？

/** 
* some text. 
*/ 
public class Foo { 
    /** 
    * Some comment... 
    */ 
    public enum Bar { 
    /** 
    * some text. 
    */ 
    ABC, 
    /** 
    * some text. 
    */ 
    CDE; 
    }; 
}

Checkstyle的说Missing a Javadoc comment.两次（ABC线和线与CDE）。这是关于什么？我应该在哪里添加评论？ JavaDoc工作得很好。

来源

2010-12-18 yegor256

可能，应指定@author @version或SMT这样。 – 2010-12-18 15:33:30

does checkstyle会给你一个行号？如果你运行javadoc，每个评论是否显示为exoected？ – atk 2010-12-18 15:34:07

我更新了我的问题，参见上文。 – yegor256 2010-12-18 15:39:27

魔术静态解决了这个问题：

/** 
* some text. 
*/ 
public class Foo { 
    /** 
    * Some comment... 
    */ 
    public static enum Bar { 
    /** 
    ...

来源

2011-03-31 07:19:17 yegor256

评论以/开头，Javadocs以/ * *开头。如果你使用后者，checkstyle会警告你缺少一些Javadoc细节。如果您打算只发表评论，请在评论开始时使用/ *。

/* 
* some text. 
*/ 
public class Foo { 
    /* 
    * Some comment... 
    */ 
    public enum Bar { 
    /* 
    * some text. 
    */ 
    ABC, 
    /* 
    * some text. 
    */ 
    CDE 
    } 
}

来源

2010-12-18 19:36:45

@Peter您能纠正我的Java代码片段，使它看起来适合checkstyle吗？ – yegor256 2010-12-18 19:51:42

@Vincenzo，也许我错过了一些东西，但对我来说似乎很简单。 – 2010-12-18 20:20:59

@Peter Hm ..没有效果。 Checkstyle一直这样说。其实我不明白你的想法。 Checkstyle说，“JavaDoc评论缺失”，你甚至建议删除我的评论..错误的方式，当然:) – yegor256 2010-12-18 21:25:32

（复制我的意见为答案，因为这似乎是目前的解决方案，它会希望能帮助得到这个问题打上封闭）

这可能是CheckStyle的一个bug。或者错误消息是不正确的（因为javadoc工作得很好）或者不清楚（比如评论是否缺少@author或者其他东西）。

来源

2010-12-27 12:58:41 atk

我也这么认为......错误报道：https://sourceforge.net/tracker/?func=detail&aid=3140236&group_id=29721&atid=397078 – yegor256 2010-12-31 08:01:28

如何评论enum使checkstyle快乐？

回答

相关问题