如何注释枚举以使 checkstyle 满意?

发布于 2024-10-08 17:34:18 字数 368 浏览 4 评论 0原文

这是代码:

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

Checkstyle 两次显示 Missing a Javadoc comment.(与 ABC 行和与 CDE 行)。这是关于什么的?我应该在哪里添加评论? JavaDoc 工作得很好。

This is the code:

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

Checkstyle says Missing a Javadoc comment. twice (line with ABC and line with CDE). What is it about? Where should I add comment? JavaDoc works just fine.

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(3

时光磨忆 2024-10-15 17:34:18

神奇的static解决了这个问题:

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

The magic static solves the problem:

/**
 * some text.
 */
public class Foo {
  /**
   * Some comment...
   */
  public static enum Bar {
    /**
     ...
蓬勃野心 2024-10-15 17:34:18

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

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

Comments start with /* and Javadocs start with /**. If you use a the latter, checkstyle will warn you that some Javadoc details are missing. If you intended to have just a comment, use /* at the start of your comment.

/*
 * some text.
 */
public class Foo {
  /*
   * Some comment...
   */
  public enum Bar {
    /*
     * some text.
     */
    ABC,
    /*
     * some text.
     */
    CDE
  }
}
素食主义者 2024-10-15 17:34:18

(将我的评论复制到答案中,因为这似乎是当前的解决方案,并且希望有助于将这个问题标记为关闭)

这可能是 checkstyle 中的错误。错误消息要么不正确(因为 javadoc 工作得很好),要么不清楚(比如注释是否缺少 @author 或其他内容)。

(copying my comment into an answer, since that seems to be the current solution, and it'll hopefully help get this question marked closed)

this may be a bug in checkstyle. either the error mesage is incorrect (since javadoc works just fine) or it's unclear (like if the comment is missing an @author or something).

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文