Checkstyle / Module / Headers

• Prev
• Next
• Checkstyle

ヘッダのチェック。

Header

ソースファイルが、指定されたヘッダから始まっていることをチェックします。

記述サンプル

• Standard Checkstyle

  <module name = "Header">
     <property name = "headerFile" value = "java.header" />
     <property name = "ignoreLines" value = "2, 5" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.HeaderCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "headerFile" value = "java.header" />
          <config-property name = "ignoreLines" value = "2, 5" />
      </config-properties>
  </rule-configuration>

RegexpHeader

Header では固定パターンのファイルでしたが、この Check では、指定したファイル内の正規表現を認識します。これにより、もっと複雑なチェックが可能になります。

ここで使われる正規表現エンジンは、Jakarta Regexp です。どのようなパターンが利用できるかは、http://jakarta.apache.org/regexp/apidocs/org/apache/regexp/RE.html を見てください。

記述サンプル

• Standard Checkstyle

  <module name = "Header">
     <property name = "headerFile" value = "java.re.header" />
     <property name = "ignoreLines" value = "2, 5" />
  </module>

• Plug-in Checkstyle

  <rule-configuration
      classname = "com.puppycrawl.tools.checkstyle.checks.HeaderCheck"
      severity = "warning">
      <config-properties>
          <config-property name = "headerFile" value = "java.re.header" />
          <config-property name = "ignoreLines" value = "2, 5" />
      </config-properties>
  </rule-configuration>

• Prev
  Checkstyle/Module/DuplicateCode
• Next
  Checkstyle/Module/Imports
• Home
  Up?