java - 如何评论枚举以使 checkstyle 快乐？

Question

这是代码：

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

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

Answer 1

神奇的静电解决了这个问题：

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

Answer 2

（将我的评论复制到答案中，因为这似乎是当前的解决方案，希望能帮助将此问题标记为已关闭）

这可能是检查样式中的错误。错误消息不正确（因为 javadoc 工作得很好）或者不清楚（比如评论是否缺少@author 或其他内容）。

Answer 3

注释以 /* 开头，Javadocs 以 / * * 开头。如果您使用后者，checkstyle 会警告您缺少一些 Javadoc 详细信息。如果您只想发表评论，请在评论开头使用 /*。

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