maven-plugins/pmd/rulesets/unusedcode.xml

106 lines
2.4 KiB
XML

<?xml version="1.0"?>
<ruleset name="Unused Code Rules">
<description>
The Unused Code Ruleset contains a collection of rules that find unused code.
</description>
<rule name="UnusedPrivateField"
message="Avoid unused private fields such as ''{0}''"
class="net.sourceforge.pmd.rules.UnusedPrivateFieldRule">
<description>
Unused Private Field detects when a private field is declared
that is not used by the class.
</description>
<example>
<![CDATA[
public class Something {
private static int FOO = 2; // Unused
private int i = 5; // Unused
private int j = 6;
public int addOne() {
return j++;
}
}
]]>
</example>
</rule>
<rule name="UnusedLocalVariable"
message="Avoid unused local variables such as ''{0}''"
class="net.sourceforge.pmd.rules.UnusedLocalVariableRule">
<description>
Unused Local Variables detects when a variable is declared, but not
used (except for possibly initial assignment)
</description>
<example>
<![CDATA[
public int doSomething() {
int i = 5; // Unused
int j = 6;
j += 3;
return j;
}
]]>
</example>
</rule>
<rule name="UnusedPrivateMethod"
message="Avoid unused private methods such as ''{0}''"
class="net.sourceforge.pmd.rules.UnusedPrivateMethodRule">
<description>
Unused Private Method detects when a private method is declared but is unused.
</description>
<example>
<![CDATA[
public class Something {
private void foo() {} // unused
}
]]>
</example>
</rule>
<rule name="UnusedFormalParameter"
message="Avoid unused formal parameters such as ''{0}''"
class="net.sourceforge.pmd.rules.UnusedFormalParameterRule">
<description>
Avoid passing parameters to methods and then not using those parameters.
</description>
<example>
<![CDATA[
public class Foo {
private void bar(String howdy) {
// howdy is not used
}
]]>
</example>
</rule>
<rule name="UnnecessaryConstructorRule"
message="Avoid unnecessary constructors - the compiler will generate these for you"
class="net.sourceforge.pmd.rules.UnnecessaryConstructorRule">
<description>
Unnecessary constructor detects when a constructor is not necessary; i.e., when there's only one constructor,
it's public, has an empty body, and takes no arguments.
</description>
<example>
<![CDATA[
public class Foo {
public Foo() {}
}
]]>
</example>
</rule>
</ruleset>