java - 将 checkstyle 设置为 java 项目构建过程的一部分

Question

我正在努力将 checkstyle 添加到 java 项目的构建过程中。 checkstyle的结果稍后会显示在jenkins上。我正在使用 java7 和 netbeans 7.2.1

对于大部分工作，我都遵循本页上的说明:http://checkstyle.sourceforge.net/anttask.html

但是，我是 java(和 jenkins)的初学者，有些说明对我来说没有意义:

1- 文档说:“要在构建文件中使用该任务，您将需要以下 taskdef 声明:”。 问题:这是要添加到build.xml文件中吗？或者在哪里？

2- 然后文档继续描述一组参数并提供一些示例。这些也要添加到 build.xml 中吗？或者？

3- Checkstyle 使用配置文件。我将使用标准 sun_checks.xml。这应该放在哪里？

如果有人可以向我指出整个过程的分步教程，我将不胜感激。 提前感谢所有答案

我在 build.xml 中使用以下内容:

<taskdef resource="checkstyletask.properties"
     classpath="libs/checkstyle-5.6-all.jar"/>

<target name="checkstyle"
        description="Generates a report of code convention violations.">

    <checkstyle config="sun_checks.xml"
                  failureProperty="checkstyle.failure"
                  failOnViolation="false">
        <fileset dir="src" includes="**/*.java"/>
        <formatter type="xml" toFile="checkstyle-results.xml"/>
    </checkstyle>

    <style in="checkstyle-results.xml" out="checkstyle_report.html" style="checkstyle.xsl"/>

</target>

Answer 1

1. 是的，您必须将其添加到 build.xml 中

2. 这些属性和元素是<checkstyle>的属性和元素。 ant 任务，由于您在第 1 点中添加了 taskdef，您可以在构建文件中使用它。是的，这个 <checkstyle>任务必须在您的 build.xml 中使用。

3. 你可以把它放在任何你想要的地方。您只需将其路径提供给 <checkstyle>使用其 config 的任务属性。