CheckStyleで自分に不要な指摘を抑制する

やりたいこと

CheckStyleで指摘されたくない項目を警告抑制する。

なぜ？

無視すると決めた警告で警告だらけになると本当に修正しないといけないものが埋もれるから

方法

TAKAHASHI, KazutakaさんがCheckstyle 日本語訳 バージョン 4.1を公開しています。感謝。

Privateなメソッドや変数とかはJavaDoc無いよって指摘されたくない。

view plainprint?

1. <module name="JavadocStyle">  
2. <!--  
3.         <module name="JavadocMethod"/>  
4.         <module name="JavadocType"/>  
5.         <module name="JavadocVariable"/>  
6. -->  
7. <!-- add myStyle -->  
8.         <module name="JavadocMethod">  
9.             <property name="scope" value="protected">  
10.         </property></module>  
11.         <module name="JavadocType">  
12.             <property name="scope" value="package">  
13.         </property></module>  
14.         <module name="JavadocVariable">  
15.             <property name="scope" value="protected">  
16.         </property></module>  
17. <!-- end myStyle -->  
18. </module>  

いまどき一行に80文字以上書いてるって指摘されたくない。

view plainprint?

1. <!-- 
2.         <module name="LineLength"/> 
3. -->     
4. <!-- add myStyle -->       
5.         <module name="LineLength">  
6.             <property name="max" value="120">  
7.         </property></module>  
8. <!-- end myStyle -->    

Parameterに代入とかしてもFindBugsが指摘してくれるからfinalは必須にしたくない。

view plainprint?

1. <!--         
2.         <module name="FinalParameters"/> 
3. -->  

ConstructorとSetterの場合はthisで指定するのでFieldを隠しても警告しない。

view plainprint?

1. <!-- 
2.         <module name="HiddenField"/> 
3. -->  
4. <!-- start myStyle -->  
5.         <module name="HiddenField">  
6.             <property name="ignoreConstructorParameter" value="true">  
7.             <property name="ignoreSetter" value="true">  
8.         </property></property></module>  
9.  <!-- end myStyle -->      

サブクラス化できるクラスの非private、非staticのメソッドをabstract、final、空実装にするのはやや苦しい。サブクラス化が必要か不必要かの判断は初回実装中に判断しにくいので。

view plainprint?

1. <!--         
2.         <module name="DesignForExtension"/> 
3. -->