如何评论枚举以使 checkstyle 快乐？答案

【问题标题】：How to comment enum to make checkstyle happy?如何评论枚举以使 checkstyle 快乐？
【发布时间】：2010-12-18 15:29:36
【问题描述】：

这是代码：

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

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

【问题讨论】：

可能，您应该像这样指定@author @version 或 smt。
checkstyle 会给你一个行号吗？如果你运行 javadoc，是否每条评论都显示为 exoected？
我更新了我的问题，见上文。
@Vincenzo，您的枚举是否包含非空构造函数？如果你用一些数字或类似这样的方式打电话给他们，你可能不会对此发表评论。
您与 checkstyle 的开发人员核实过吗？这可以。是一个错误（要么它抱怨缺少没有丢失的 javadoc，要么它给出了错误的错误消息）。

标签： java checkstyle

【解决方案1】：

神奇的静态解决了问题：

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

【讨论】：

【解决方案2】：

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

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

【讨论】：

@Peter 您能否更正我的 Java sn-p 以使其看起来适合 checkstyle？
@Vincenzo，也许我遗漏了什么，但对我来说似乎很简单。
@Peter Hm.. 没有效果。 Checkstyle 一直这么说。其实我没有理解你的想法。 Checkstyle 说“缺少 JavaDoc 注释”，并且您建议删除我拥有的 cmets.. 肯定是错误的方式：)
@Vincenzo。我不知道您在做什么，或者您正在查看什么示例，但在我的示例中，cmets 仍然存在并且没有 javadocs，因此该错误没有任何意义。我不知道如何使这更简单或更简单。
@Peter 什么是“错误没有任何意义”？错误仍然存在，因此没有构建项目.. :)

【解决方案3】：

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

这可能是 checkstyle 中的一个错误。错误消息不正确（因为 javadoc 工作正常）或不清楚（例如评论是否缺少@author 或其他内容）。

【讨论】：

我也这么认为... 报错：sourceforge.net/tracker/…