PMD 规则集文件

Question

我试图弄清楚默认规则集文件在哪里，默认规则集文件的名称以及我们如何向其中添加自己的规则。我尝试用谷歌搜索，但这让我很困惑。到目前为止，我已将 pmd 插件放入 eclipse 插件文件夹中，在首选项中我可以看到 PMD。

Answer 1

标准规则集文件是 *.xml，位于 pmd-bin-x.x.x.zip/.../lib/pmd-x.x.x.jar/rulesets/， 请参阅 http://pmd.sourceforge.net/rules/index.html.

例如，对于 Windows 下的 pmd 7.0 rc 3，带有规则集的 jar 文件如下所示

PMD Eclipse Plugin的默认规则集文件位于{IDE}/plugins/...中的pmd___.jar内，但您不应对该文件进行任何更改。 在 Eclipse Preferences 中添加/编辑规则，任何更改都将优先于默认规则集。

考虑到 pmd 在 Windows 下解压到

C:\Apps\pmd-bin-7.0.0-rc3

，包含 jar 文件的文件夹如下所示

您可以解压 jar 文件来查看里面的文件：

Answer 2

在与 Ant 和 PMD 搞混了很长一段时间之后，这是我想出的完整解决方案。根据自己的口味修改。

---

这设置了我使用的初始目录。

<property name="doc" location="doc" />               <!-- Root for all documentation: -->
<property name="pmddoc" location="${doc}/pmddoc" />  <!-- PMD results -->

---

这是我的任务定义，它指向我当前存储的 PMD 的最新版本。它包括 PMD Jar 本身（存储所有规则的地方）以及所有 PMD 的依赖项。

<taskdef name="pmd" classname="net.sourceforge.pmd.ant.PMDTask">
    <classpath>
        <fileset dir="C:\development\pmd-bin-5.0-alpha">
            <include name="lib/*.jar"/>    <!-- also includes pmd's file, which has all the rulesets I need. -->
        </fileset>
    </classpath>
</taskdef>

---

在初始化时，如果需要，我会创建文档文件夹：

<target name="init">
    <mkdir dir="${pmddoc}" />
</target>

---

...最后，我创建了一个专门用于以 HTML 形式创建 PMD 报告的目标。在这里。

<target name="pmd" depends="init">
    <pmd>
        <formatter type="html" toFile="${pmddoc}/pmd_src_report.html" toConsole="true"/>

        <ruleset>rulesets/java/basic.xml</ruleset> <!-- references file in PMD's .jar -->

        <!-- Files PMD will test. -->       
        <fileset dir="${src}">
            <include name="**/*.java"/>     <!-- required to avoid firing off .aj errors. This ruleset doesn't support AspectJ. -->
        </fileset>
    </pmd>
</target>