Checkstyle / Module / Miscellaneous

• Prev
• Next
• Checkstyle

GenericIllegalRegexp

指定した正規表現にマッチする部分があるかをチェックします。Checkstyle は正規表現エンジンとして、Jakarta Regexp を使っている。

記述サンプル

• Standard Checkstyle

  <module name = "GenericIllegalRegexp">
     <property name = "format" value = "System\.out\.println" />
     <property name = "message" value = "" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.GenericIllegalRegexpCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "format" value = "System\.out\.println" />
      </config-properties>
  </rule-configuration>

NewlineAtEndOfFile

ファイルの最後が改行で終わっているかをチェックします。

Rationale: ソースファイルやテキストファイルは、一般的に改行文字で終わるべきである。特に、CVS のような SCM を使っているときは。CVS は、改行文字で終わっていないファイルを見つけるたびに、警告を出力することになります。

記述サンプル

• Standard Checkstyle

  <module name = "NewlineAtEndOfFile">
     <property name = "lineSeparator" value = "lf" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "lineSeparator" value = "lf" />
      </config-properties>
  </rule-configuration>

TodoComment

TODO: があるかをチェックします。このチェックは、Java コメント内である正規表現にマッチするかをチェックするために汎用的に使えるものです。他のパターンでチェックしたい場合は、format プロパティで指定します。

TODO: コメントは、やるべきことが分かるようにしておく方法として有用です。これを Checkstyle によってチェックさせることによって、忘れちゃうのを防げます。

記述サンプル

• Standard Checkstyle

  <module name = "TodoComment" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.NewlineAtEndOfFileCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

Translation

複数のプロパティファイルに、まったく同じプロパティが各ファイルに存在するかをチェックします。ようは、PropertyResourceBundle を使うときに異なるロケールのプロパティファイルのチェックに使うものです。

記述サンプル

• Standard Checkstyle

  <module name = "Translation" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.TranslationCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

UpperEll

long 定数を定義するときに、L(大文字のL)を使っているかをチェックします。

Rationale: l(小文字のL)は、1(数字の1)に良く似ているため。

記述サンプル

• Standard Checkstyle

  <module name = "UpperEll" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.UpperEllCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

ArrayTypeStyle

配列を宣言するときの書き方をチェックします。

• Java-style: public static void main(String[] args)
• C-style: public static void main(String args[])

記述サンプル

• Standard Checkstyle

  <module name = "ArrayTypeStyle" />

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.ArrayTypeStyleCheck"
      severity = "warning">
      <config-properties />
  </rule-configuration>

チェックサンプル

<module name = "ArrayTyleStyle" />

としたときに、以下のようになる。

OK!  public static void main(String[] args) {
Boo! public static void main(String args[]) {

FinalParameters

メソッド及びコンストラクタのパラメタの宣言に final がついていることをチェックします。このチェックは、インターフェイスのメソッドには行いません。それは、インターフェイスには実装が無いため、パラメタが変更されることもないからです。

Rationale: パラメタとして渡したオブジェクトが変更されてしまうことは、混乱を招くため避けるべきです。これを防ぐためのよい方法は、パラメタにすべて final をつけることによって、コンパイラにチェックしてもらうことです。

記述サンプル

• Standard Checkstyle

  <module name = "FinalParameters">
     <property name = "tokens" value = "METHOD_DEF" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.FinalParametersCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "tokens" value = "METHOD_DEF" />
      </config-properties>
  </rule-configuration>

チェックサンプル

<module name = "FinalParameters" />

としたときに、以下のようになる。

OK!  public void replaceNotation(final String value) {
Boo! public void replaceNotation(String value) {

Indentation

コードが正しくインデントされているかをチェックします。

• Prev
  Checkstyle/Module/Metrics
• Next
  Checkstyle/Module/Modifiers
• Home
  Up?