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

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

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

Answer 3

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

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

如何评论enum让checkstyle开心？

3 个答案: