Checkstyle / Module / SizeViolations

• Prev
• Next
• Checkstyle

サイズに関するチェック。

ExecutableStatementCount

メソッドなどのメンバ内に存在する文の数をチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "ExecutableStatementCount">
      <property name = "max" value = "45" />
      <property name = "tokens" value = "METHOD_DEF" />
  </module>

FileLength

ソースファイルの行数がある一定上でないかをチェックします。

Rationale: ソースコードがとても長かった場合は、理解するのが難しい。そのため、長いクラスは通常、限定された仕事にフォーカスするように幾つかの個別のクラスにリファクタリングすべきです。

記述サンプル

• Standard Checkstyle

  <module name = "FileLength">
      <property name = "max" value = "1500" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.FileLengthCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "max" value = "1500" />
      </config-properties>
  </rule-configuration>

LineLength

一行の文字数が、ある一定以上ではないかをチェックします。

Rationale: 長い行は、ソースコードをプリントアウトときや開発者が制限された画面上(例えば、IDEではプロジェクトツリーやクラス階層図などの追加情報が表示されています)で見る場合は読みづらいものです。

記述サンプル

• Standard Checkstyle

  <module name = "LineLength">
      <property name = "ignorePattern" value = "^ *\*" />
      <property name = "max" value = "80" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.LineLengthCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "ignorePattern" value = "^ *\*" />
          <config-property name = "max" value = "80" />
      </config-properties>
  </rule-configuration>

MethodLength

メソッド及びコンストラクタの定義に含まれる行数をチェックします。

Rationale: メソッドがとても長かったら、理解するのが難しくなります。そのため、長いメソッドは通常、限定された仕事にフォーカスするように幾つかの個別のメソッドにリファクタリングすべきです。

記述サンプル

• Standard Checkstyle

  <module name = "MethodLength">
      <property name = "max" value = "100" />
      <property name = "tokens" value = "METHOD_DEF" />
  </module>

• Plug-in Checkstyle

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

AnonInnerLength

無名クラスの定義内に含まれる行数をチェックします。

Rationale: 無名クラスの定義が恐ろしく長かったら、理解が難しくなり、メソッド内の処理の流れを追うことが困難になります。そのため、長い無名クラスは名前を持ったクラスにするようにリファクタリングすべきなのです。詳しくは、Bloch の Effective Java の P.93 を。

記述サンプル

• Standard Checkstyle

  <module name = "AnonInnerLength">
      <property name = "max" value = "30" />
  </module>

ParameterNumber

メソッド及びコンストラクタのパラメータの数をチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "MethodLength">
      <property name = "max" value = "5" />
      <property name = "tokens" value = "METHOD_DEF" />
  </module>

• Plug-in Checkstyle

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

チェックサンプル

<module name = "MethodLength">
    <property name = "max" value = "2" />
</module>

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

OK!  public void setAttribute(String name, String[] values) {
Boo! public void setAttribute(String name, String value1, String value2) {

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