Wie man enum kommentiert, um checkstyle glücklich zu machen?

Question

Dies ist der Code:

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

Check sagt Missing a Javadoc comment. zweimal (Linie mit ABC und Linie mit CDE). Worum geht es? Wo sollte ich einen Kommentar hinzufügen? JavaDoc funktioniert gut.

Answer 1

Die Magie statischen löst das Problem:

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

Answer 2

Kommentare beginnen mit/* und Javadocs beginnen mit/* *. Wenn Sie ein letzteres verwenden, wird checkstyle Sie warnen, dass einige Javadoc-Details fehlen. Wenn Sie nur einen Kommentar haben möchten, verwenden Sie am Anfang Ihres Kommentars/*.

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

Answer 3

(Kopieren meines Kommentars in eine Antwort, denn das ist die aktuelle Lösung zu sein scheint, und es wird hoffentlich helfen, diese Frage geschlossen markiert zu bekommen) dieses

kann ein Fehler in sein check. entweder ist die Fehlermeldung falsch (da javadoc einwandfrei funktioniert) oder es ist unklar (wie wenn der Kommentar einen @author oder etwas fehlt).