Checkstyle

checkstyle用來檢查程式的寫法是否有遵循一定的風格(一行長度太長或命名不合規範等…)。

maven-checkstyle-plugin預設使用Sun的程式風格,您也可以使用其它的風格寫作,例如Google Style,做法就是下載設定檔到本機,然後在<configuration>的<configLocation>指向設定檔。

一般我的設定檔如下:

<pom>
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>
        <version>3.3.1</version>
        <configuration>
          <failsOnError>false</failsOnError>
          <linkXRef>false</linkXRef>
        </configuration>
        <reportSets>
          <reportSet>
            <reports>
              <report>checkstyle</report>
            </reports>
          </reportSet>
        </reportSets>
      <plugin>
    </plugins>
  </reporting>
</pom>

PMD一樣,Checkstyle本身沒有提供報表,所以必須都做一點設定,以便整合進專案報表中。