Как прокомментировать перечисление, чтобы сделать чекстайл счастливым?

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

(копирование моего комментария в ответ, так как это, кажется, текущее решение, и, надеюсь, поможет пометить этот вопрос закрытым)

это может быть ошибка в checkstyle. либо сообщение об ошибке неверно (поскольку javadoc работает просто отлично), либо неясно (например, если в комментарии отсутствует @author или что-то еще).

Answer 3

Комментарии начинаются с / *, а Javadocs начинаются с / **. Если вы используете последний, checkstyle предупредит вас, что некоторые детали Javadoc отсутствуют. Если вы намеревались получить только комментарий, используйте / * в начале вашего комментария.

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