如何評論enum使checkstyle快樂？

這是代碼：如何評論enum使checkstyle快樂？

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

Checkstyle的說Missing a Javadoc comment.兩次（ABC線和線與CDE）。這是關於什麼？我應該在哪裏添加評論？ JavaDoc工作得很好。

來源

2010-12-18 yegor256

可能，應指定@author @version或SMT這樣。 – 2010-12-18 15:33:30

does checkstyle會給你一個行號？如果你運行javadoc，每個評論是否顯示爲exoected？ – atk 2010-12-18 15:34:07

我更新了我的問題，參見上文。 – yegor256 2010-12-18 15:39:27

魔術靜態解決了這個問題：

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

來源

2011-03-31 07:19:17 yegor256

評論以/開頭，Javadocs以/ * *開頭。如果你使用後者，checkstyle會警告你缺少一些Javadoc細節。如果您打算只發表評論，請在評論開始時使用/ *。

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

來源

2010-12-18 19:36:45

@Peter您能糾正我的Java代碼片段，使它看起來適合checkstyle嗎？ – yegor256 2010-12-18 19:51:42

@Vincenzo，也許我錯過了一些東西，但對我來說似乎很簡單。 – 2010-12-18 20:20:59

@Peter Hm ..沒有效果。 Checkstyle一直這樣說。其實我不明白你的想法。 Checkstyle說，「JavaDoc評論缺失」，你甚至建議刪除我的評論..錯誤的方式，當然:) – yegor256 2010-12-18 21:25:32

（複製我的意見爲答案，因爲這似乎是目前的解決方案，它會希望能幫助得到這個問題打上封閉）

這可能是CheckStyle的一個bug。或者錯誤消息是不正確的（因爲javadoc工作得很好）或者不清楚（比如評論是否缺少@author或者其他東西）。

來源

2010-12-27 12:58:41 atk

我也這麼認爲......錯誤報道：https://sourceforge.net/tracker/?func=detail&aid=3140236&group_id=29721&atid=397078 – yegor256 2010-12-31 08:01:28

如何評論enum使checkstyle快樂？

回答

相關問題