phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=3562.1
TRAVIS_COMMIT_RANGE=1876a068e6ba...1337dce1fba8
This commit is contained in:
Travis CI (pmd-bot)
2019-03-19 16:34:34 +00:00
parent 1337dce1fb
commit 3a866ddb9f
22 changed files with 1367 additions and 274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/pages/pmd/rules/apex/bestpractices.md
View File

@@ -38,11 +38,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Bug Risk|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/bestpractices.xml/ApexUnitTestClassShouldHaveAsserts" />
```
@@ -75,11 +75,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Bug Risk|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/bestpractices.xml/ApexUnitTestShouldNotUseSeeAllDataTrue" />
```
@@ -110,10 +110,10 @@ global class Unchangeable {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/bestpractices.xml/AvoidGlobalModifier" />
```
@@ -154,10 +154,10 @@ trigger Accounts on Account (before insert, before update, before delete, after
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|200|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/bestpractices.xml/AvoidLogicInTrigger" />
```

57
docs/pages/pmd/rules/apex/codestyle.md
View File

@@ -30,10 +30,10 @@ public class Foo {}
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|5|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/ClassNamingConventions" />
```
@@ -74,7 +74,7 @@ for (int i = 0; i < 42; i++) { // preferred approach
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/ForLoopsMustUseBraces" />
```
@@ -117,7 +117,7 @@ else
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/IfElseStmtsMustUseBraces" />
```
@@ -156,7 +156,7 @@ if (foo) { // preferred approach
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/IfStmtsMustUseBraces" />
```
@@ -189,11 +189,20 @@ public class Foo {
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
|skipTestMethodUnderscores|false|Skip underscores in test methods|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/MethodNamingConventions" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/apex/codestyle.xml/MethodNamingConventions">
<properties>
<property name="skipTestMethodUnderscores" value="false" />
</properties>
</rule>
```
## OneDeclarationPerLine
**Since:** PMD 6.7.0
@@ -235,11 +244,20 @@ Integer b;
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
|strictMode|false|If true, mark combined declaration even if the declarations are on separate lines.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/OneDeclarationPerLine" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/apex/codestyle.xml/OneDeclarationPerLine">
<properties>
<property name="strictMode" value="false" />
</properties>
</rule>
```
## VariableNamingConventions
**Since:** PMD 5.5.0
@@ -267,7 +285,7 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|5|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
|checkMembers|true|Check member variables|no|
|checkLocals|true|Check local variables|no|
@@ -281,11 +299,30 @@ public class Foo {
|parameterPrefix||Method parameter variable prefixes|yes. Delimiter is ','.|
|parameterSuffix||Method parameter variable suffixes|yes. Delimiter is ','.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/VariableNamingConventions" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/apex/codestyle.xml/VariableNamingConventions">
<properties>
<property name="checkMembers" value="true" />
<property name="checkLocals" value="true" />
<property name="checkParameters" value="true" />
<property name="staticPrefix" value="" />
<property name="staticSuffix" value="" />
<property name="memberPrefix" value="" />
<property name="memberSuffix" value="" />
<property name="localPrefix" value="" />
<property name="localSuffix" value="" />
<property name="parameterPrefix" value="" />
<property name="parameterSuffix" value="" />
</properties>
</rule>
```
## WhileLoopsMustUseBraces
**Since:** PMD 5.6.0
@@ -320,7 +357,7 @@ while (true) { // preferred approach
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/codestyle.xml/WhileLoopsMustUseBraces" />
```

185
docs/pages/pmd/rules/apex/design.md
View File

File diff suppressed because it is too large Load Diff

2
docs/pages/pmd/rules/apex/documentation.md
View File

@@ -52,7 +52,7 @@ public class HelloWorld {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/documentation.xml/ApexDoc" />
```

22
docs/pages/pmd/rules/apex/errorprone.md
View File

@@ -42,7 +42,7 @@ trigger AccountTrigger on Account (before insert, before update) {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/AvoidDirectAccessTriggerMap" />
```
@@ -79,10 +79,10 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/AvoidHardcodingId" />
```
@@ -118,7 +118,7 @@ A full list of supported annotations can be found at https://developer.salesforc
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/AvoidNonExistentAnnotations" />
```
@@ -159,7 +159,7 @@ public void doSomething() {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/EmptyCatchBlock" />
```
@@ -198,7 +198,7 @@ public class Foo {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/EmptyIfStmt" />
```
@@ -239,7 +239,7 @@ public class Foo {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/EmptyStatementBlock" />
```
@@ -289,7 +289,7 @@ public class Foo {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/EmptyTryOrFinallyBlock" />
```
@@ -327,7 +327,7 @@ public void bar(Integer a, Integer b) {
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/EmptyWhileStmt" />
```
@@ -358,10 +358,10 @@ public class MyClass {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_remediation\_points\_multiplier|50|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/errorprone.xml/MethodWithSameNameAsEnclosingClass" />
```

18
docs/pages/pmd/rules/apex/performance.md
View File

@@ -37,11 +37,11 @@ public class Something {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Performance|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|150|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/performance.xml/AvoidDmlStatementsInLoops" />
```
@@ -72,11 +72,11 @@ public class Something {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Performance|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|150|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/performance.xml/AvoidSoqlInLoops" />
```
@@ -107,11 +107,11 @@ public class Something {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Performance|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|150|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/performance.xml/AvoidSoslInLoops" />
```

66
docs/pages/pmd/rules/apex/security.md
View File

@@ -35,11 +35,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexBadCrypto" />
```
@@ -79,11 +79,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexCRUDViolation" />
```
@@ -117,11 +117,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexCSRF" />
```
@@ -157,11 +157,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexDangerousMethods" />
```
@@ -192,11 +192,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexInsecureEndpoint" />
```
@@ -227,11 +227,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexOpenRedirect" />
```
@@ -259,11 +259,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexSharingViolations" />
```
@@ -292,11 +292,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexSOQLInjection" />
```
@@ -339,11 +339,11 @@ public class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexSuggestUsingNamedCred" />
```
@@ -372,11 +372,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|100|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexXSSFromEscapeFalse" />
```
@@ -405,11 +405,11 @@ public without sharing class Foo {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|cc\_categories|Style|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|1|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_categories|Security|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Categories|yes. Delimiter is '\|'.|
|cc\_remediation\_points\_multiplier|50|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Remediation Points multiplier|no|
|cc\_block\_highlighting|false|<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Code Climate Block Highlighting|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/apex/security.xml/ApexXSSFromURLParam" />
```

15
docs/pages/pmd/rules/ecmascript/bestpractices.md
View File

@@ -71,15 +71,26 @@ function bar() {
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|rhinoLanguageVersion|VERSION\_DEFAULT|Specifies the Rhino Language Version to use for parsing. Defaults to Rhino default.|no|
|rhinoLanguageVersion|default|Specifies the Rhino Language Version to use for parsing. Defaults to Rhino default.|no|
|recordingLocalJsDocComments|true|Specifies that JsDoc comments are produced in the AST.|no|
|recordingComments|true|Specifies that comments are produced in the AST.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/ecmascript/bestpractices.xml/ConsistentReturn" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/ecmascript/bestpractices.xml/ConsistentReturn">
<properties>
<property name="rhinoLanguageVersion" value="default" />
<property name="recordingLocalJsDocComments" value="true" />
<property name="recordingComments" value="true" />
</properties>
</rule>
```
## GlobalVariable
**Since:** PMD 5.0

16
docs/pages/pmd/rules/ecmascript/codestyle.md
View File

@@ -58,11 +58,25 @@ function getX() {
|allowTernaryResults|false|Allow assignment within the result expressions of a ternary operator|no|
|allowIncrementDecrement|false|Allow increment or decrement operators within the conditional expression of an if, for, or while statement|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/ecmascript/codestyle.xml/AssignmentInOperand" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/ecmascript/codestyle.xml/AssignmentInOperand">
<properties>
<property name="allowIf" value="false" />
<property name="allowFor" value="false" />
<property name="allowWhile" value="false" />
<property name="allowTernary" value="false" />
<property name="allowTernaryResults" value="false" />
<property name="allowIncrementDecrement" value="false" />
</properties>
</rule>
```
## ForLoopsMustUseBraces
**Since:** PMD 5.0

12
docs/pages/pmd/rules/ecmascript/errorprone.md
View File

@@ -43,11 +43,21 @@ function(arg) {
|allowObjectLiteral|false|Allow a trailing comma within an object literal|no|
|allowArrayLiteral|false|Allow a trailing comma within an array literal|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/ecmascript/errorprone.xml/AvoidTrailingComma" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/ecmascript/errorprone.xml/AvoidTrailingComma">
<properties>
<property name="allowObjectLiteral" value="false" />
<property name="allowArrayLiteral" value="false" />
</properties>
</rule>
```
## EqualComparison
**Since:** PMD 5.0

134
docs/pages/pmd/rules/java/bestpractices.md
View File

@@ -230,11 +230,21 @@ public class Foo {
|foreachReassign|deny|how/if foreach control variables may be reassigned|no|
|forReassign|deny|how/if for control variables may be reassigned|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/AvoidReassigningLoopVariables" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/AvoidReassigningLoopVariables">
<properties>
<property name="foreachReassign" value="deny" />
<property name="forReassign" value="deny" />
</properties>
</rule>
```
## AvoidReassigningParameters
**Since:** PMD 1.0
@@ -312,11 +322,20 @@ public class Foo {
|----|-------------|-----------|-----------|
|checkAddressTypes|IPv4 mapped IPv6 \| IPv6 \| IPv4|Check for IP address types.|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/AvoidUsingHardCodedIP">
<properties>
<property name="checkAddressTypes" value="IPv4 mapped IPv6|IPv6|IPv4" />
</properties>
</rule>
```
## CheckResultSet
**Since:** PMD 4.1
@@ -395,11 +414,20 @@ public interface YetAnotherConstantInterface {
|----|-------------|-----------|-----------|
|ignoreIfHasMethods|true|Whether to ignore constants in interfaces if the interface defines any methods|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/ConstantsInInterface" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/ConstantsInInterface">
<properties>
<property name="ignoreIfHasMethods" value="true" />
</properties>
</rule>
```
## DefaultLabelNotLastInSwitchStmt
**Since:** PMD 1.5
@@ -501,11 +529,20 @@ for (int i = 0, j = 0; i < 10; i++, j += 2) {
|----|-------------|-----------|-----------|
|maximumVariables|1|A regular for statement will have 1 control variable|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/ForLoopVariableCount" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/ForLoopVariableCount">
<properties>
<property name="maximumVariables" value="1" />
</properties>
</rule>
```
## GuardLogStatement
**Since:** PMD 5.1.0
@@ -532,11 +569,21 @@ otherwise skip the associate String creation and manipulation.
|logLevels|trace , debug , info , warn , error , log , finest , finer , fine , info , warning , severe|LogLevels to guard|yes. Delimiter is ','.|
|guardsMethods|isTraceEnabled , isDebugEnabled , isInfoEnabled , isWarnEnabled , isErrorEnabled , isLoggable|Method use to guard the log statement|yes. Delimiter is ','.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/GuardLogStatement" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/GuardLogStatement">
<properties>
<property name="logLevels" value="trace,debug,info,warn,error,log,finest,finer,fine,info,warning,severe" />
<property name="guardsMethods" value="isTraceEnabled,isDebugEnabled,isInfoEnabled,isWarnEnabled,isErrorEnabled,isLoggable" />
</properties>
</rule>
```
## JUnit4SuitesShouldUseSuiteAnnotation
**Since:** PMD 4.0
@@ -702,11 +749,20 @@ public class MyTest {
|----|-------------|-----------|-----------|
|testClassPattern|Test|The regex pattern used to identify test classes|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/JUnit4TestShouldUseTestAnnotation" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/JUnit4TestShouldUseTestAnnotation">
<properties>
<property name="testClassPattern" value="Test" />
</properties>
</rule>
```
## JUnitAssertionsShouldIncludeMessage
**Since:** PMD 1.04
@@ -787,11 +843,20 @@ public class MyTestCase extends TestCase {
|----|-------------|-----------|-----------|
|maximumAsserts|1|Maximum number of Asserts in a test method|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/JUnitTestContainsTooManyAsserts" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/JUnitTestContainsTooManyAsserts">
<properties>
<property name="maximumAsserts" value="1" />
</properties>
</rule>
```
## JUnitTestsShouldIncludeAssert
**Since:** PMD 2.0
@@ -993,11 +1058,20 @@ String name,
|----|-------------|-----------|-----------|
|strictMode|false|If true, mark combined declaration even if the declarations are on separate lines.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/OneDeclarationPerLine" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/OneDeclarationPerLine">
<properties>
<property name="strictMode" value="false" />
</properties>
</rule>
```
## PositionLiteralsFirstInCaseInsensitiveComparisons
**Since:** PMD 5.1
@@ -1303,11 +1377,20 @@ public class Foo {
|----|-------------|-----------|-----------|
|checkAll|false|Check all methods, including non-private ones|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedFormalParameter" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedFormalParameter">
<properties>
<property name="checkAll" value="false" />
</properties>
</rule>
```
## UnusedImports
**Since:** PMD 1.0
@@ -1387,11 +1470,20 @@ public class Something {
|----|-------------|-----------|-----------|
|ignoredAnnotations|lombok.Setter \| lombok.Getter \| lombok.Builder \| lombok.Data \| lombok.RequiredArgsConstructor \| lombok.AllArgsConstructor \| lombok.Value \| lombok.NoArgsConstructor \| java.lang.Deprecated \| javafx.fxml.FXML|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedPrivateField" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedPrivateField">
<properties>
<property name="ignoredAnnotations" value="lombok.Setter|lombok.Getter|lombok.Builder|lombok.Data|lombok.RequiredArgsConstructor|lombok.AllArgsConstructor|lombok.Value|lombok.NoArgsConstructor|java.lang.Deprecated|javafx.fxml.FXML" />
</properties>
</rule>
```
## UnusedPrivateMethod
**Since:** PMD 0.7
@@ -1416,11 +1508,20 @@ public class Something {
|----|-------------|-----------|-----------|
|ignoredAnnotations|java.lang.Deprecated|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedPrivateMethod" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/UnusedPrivateMethod">
<properties>
<property name="ignoredAnnotations" value="java.lang.Deprecated" />
</properties>
</rule>
```
## UseAssertEqualsInsteadOfAssertTrue
**Since:** PMD 3.1
@@ -1694,11 +1795,20 @@ public class TryWithResources {
|----|-------------|-----------|-----------|
|closeMethods|close , closeQuietly|Method names in finally block, which trigger this rule|yes. Delimiter is ','.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/bestpractices.xml/UseTryWithResources" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/bestpractices.xml/UseTryWithResources">
<properties>
<property name="closeMethods" value="close,closeQuietly" />
</properties>
</rule>
```
## UseVarargs
**Since:** PMD 5.0

303
docs/pages/pmd/rules/java/codestyle.md
View File

File diff suppressed because it is too large Load Diff

318
docs/pages/pmd/rules/java/design.md
View File

File diff suppressed because it is too large Load Diff

53
docs/pages/pmd/rules/java/documentation.md
View File

@@ -32,11 +32,21 @@ A rule for the politically correct... we don't want to offend anyone.
|caseSensitive|false|Case sensitive|no|
|disallowedTerms|idiot \| jerk|Illegal terms or phrases|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/documentation.xml/CommentContent" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/documentation.xml/CommentContent">
<properties>
<property name="caseSensitive" value="false" />
<property name="disallowedTerms" value="idiot|jerk" />
</properties>
</rule>
```
## CommentRequired
**Since:** PMD 5.1
@@ -70,11 +80,27 @@ Denotes whether comments are required (or unwanted) for specific language elemen
|enumCommentRequirement|Required|Enum comments. Possible values: \[Required, Ignored, Unwanted\]|no|
|serialVersionUIDCommentRequired|Ignored|Serial version UID comments. Possible values: \[Required, Ignored, Unwanted\]|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/documentation.xml/CommentRequired" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/documentation.xml/CommentRequired">
<properties>
<property name="methodWithOverrideCommentRequirement" value="Ignored" />
<property name="accessorCommentRequirement" value="Ignored" />
<property name="headerCommentRequirement" value="Required" />
<property name="fieldCommentRequirement" value="Required" />
<property name="publicMethodCommentRequirement" value="Required" />
<property name="protectedMethodCommentRequirement" value="Required" />
<property name="enumCommentRequirement" value="Required" />
<property name="serialVersionUIDCommentRequired" value="Ignored" />
</properties>
</rule>
```
## CommentSize
**Since:** PMD 5.0
@@ -113,11 +139,21 @@ Determines whether the dimensions of non-header comments found are within the sp
|maxLines|6|Maximum lines|no|
|maxLineLength|80|Maximum line length|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/documentation.xml/CommentSize" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/documentation.xml/CommentSize">
<properties>
<property name="maxLines" value="6" />
<property name="maxLineLength" value="80" />
</properties>
</rule>
```
## UncommentedEmptyConstructor
**Since:** PMD 3.4
@@ -150,11 +186,20 @@ public Foo() {
|----|-------------|-----------|-----------|
|ignoreExplicitConstructorInvocation|false|Ignore explicit constructor invocation when deciding whether constructor is empty or not|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/documentation.xml/UncommentedEmptyConstructor" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/documentation.xml/UncommentedEmptyConstructor">
<properties>
<property name="ignoreExplicitConstructorInvocation" value="false" />
</properties>
</rule>
```
## UncommentedEmptyMethodBody
**Since:** PMD 3.4

124
docs/pages/pmd/rules/java/errorprone.md
View File

@@ -39,11 +39,23 @@ public void bar() {
|allowWhile|false|Allow assignment within the conditional expression of a while statement|no|
|allowIncrementDecrement|false|Allow increment or decrement operators within the conditional expression of an if, for, or while statement|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/AssignmentInOperand" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/AssignmentInOperand">
<properties>
<property name="allowIf" value="false" />
<property name="allowFor" value="false" />
<property name="allowWhile" value="false" />
<property name="allowIncrementDecrement" value="false" />
</properties>
</rule>
```
## AssignmentToNonFinalStatic
**Since:** PMD 2.2
@@ -209,11 +221,22 @@ for (int i = 0; i < 10; i++) {
|checkContinueLoopTypes|for \| do \| while|List of loop types in which continue statements will be checked|yes. Delimiter is '\|'.|
|checkReturnLoopTypes|for \| do \| while|List of loop types in which return statements will be checked|yes. Delimiter is '\|'.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidBranchingStatementAsLastInLoop" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidBranchingStatementAsLastInLoop">
<properties>
<property name="checkBreakLoopTypes" value="for|do|while" />
<property name="checkContinueLoopTypes" value="for|do|while" />
<property name="checkReturnLoopTypes" value="for|do|while" />
</properties>
</rule>
```
## AvoidCallingFinalize
**Since:** PMD 3.0
@@ -389,11 +412,24 @@ private void buz(String x) {}
|skipAnnotations|false|Skip literals within annotations|no|
|exceptionList||List of literals to ignore. A literal is ignored if its image can be found in this list. Components of this list should not be surrounded by double quotes.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidDuplicateLiterals">
<properties>
<property name="separator" value="," />
<property name="maxDuplicateLiterals" value="4" />
<property name="minimumLength" value="3" />
<property name="skipAnnotations" value="false" />
<property name="exceptionList" value="" />
</properties>
</rule>
```
## AvoidEnumAsIdentifier
**Since:** PMD 3.4
@@ -562,11 +598,20 @@ public void checkRequests() {
|----|-------------|-----------|-----------|
|ignoreMagicNumbers|-1,0|Comma-separated list of magic numbers, that should be ignored|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidLiteralsInIfCondition" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidLiteralsInIfCondition">
<properties>
<property name="ignoreMagicNumbers" value="-1,0" />
</properties>
</rule>
```
## AvoidLosingExceptionInformation
**Since:** PMD 4.2.6
@@ -672,11 +717,20 @@ k = i * j; // set k with 80 not 120
|----|-------------|-----------|-----------|
|strict|false|Detect violations between 00 and 07|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidUsingOctalValues" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/AvoidUsingOctalValues">
<properties>
<property name="strict" value="false" />
</properties>
</rule>
```
## BadComparison
**Since:** PMD 1.8
@@ -741,11 +795,21 @@ private int getMoreFoo(){
|ignoredAnnotations|lombok.Data \| lombok.Getter \| lombok.Value|Fully qualified names of the annotation types that should be ignored by this rule|yes. Delimiter is '\|'.|
|prefix||A variable prefix to skip, i.e., m\_|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/BeanMembersShouldSerialize" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/BeanMembersShouldSerialize">
<properties>
<property name="ignoredAnnotations" value="lombok.Data|lombok.Getter|lombok.Value" />
<property name="prefix" value="" />
</properties>
</rule>
```
## BrokenNullCheck
**Since:** PMD 3.8
@@ -1129,11 +1193,22 @@ public class Bar {
|types|java.sql.Connection , java.sql.Statement , java.sql.ResultSet|Affected types|yes. Delimiter is ','.|
|closeAsDefaultTarget|true|Consider 'close' as a target by default|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/CloseResource" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/CloseResource">
<properties>
<property name="closeTargets" value="" />
<property name="types" value="java.sql.Connection,java.sql.Statement,java.sql.ResultSet" />
<property name="closeAsDefaultTarget" value="true" />
</properties>
</rule>
```
## CompareObjectsWithEquals
**Since:** PMD 3.2
@@ -1236,11 +1311,21 @@ public void foo() {
|maxPaths|1000|Maximum number of checked paths per method. A lower value will increase the performance of the rule but may decrease anomalies found.|no|
|maxViolations|100|Maximum number of anomalies per class|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/DataflowAnomalyAnalysis" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/DataflowAnomalyAnalysis">
<properties>
<property name="maxPaths" value="1000" />
<property name="maxViolations" value="100" />
</properties>
</rule>
```
## DetachedTestCase
**Since:** PMD 6.13.0
@@ -1571,11 +1656,21 @@ public void doSomething() {
|allowCommentedBlocks|false|Empty blocks containing comments will be skipped|no|
|allowExceptionNameRegex|^(ignored\|expected)$|Empty blocks catching exceptions with names matching this regular expression will be skipped|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/EmptyCatchBlock" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/EmptyCatchBlock">
<properties>
<property name="allowCommentedBlocks" value="false" />
<property name="allowExceptionNameRegex" value="^(ignored|expected)$" />
</properties>
</rule>
```
## EmptyFinalizer
**Since:** PMD 1.5
@@ -2784,11 +2879,20 @@ public class Foo {
|----|-------------|-----------|-----------|
|staticLoggerName|LOG|Name of the static Logger variable|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/errorprone.xml/ProperLogger" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/errorprone.xml/ProperLogger">
<properties>
<property name="staticLoggerName" value="LOG" />
</properties>
</rule>
```
## ReturnEmptyArrayRatherThanNull
**Since:** PMD 4.2

12
docs/pages/pmd/rules/java/multithreading.md
View File

@@ -268,11 +268,21 @@ public static Foo getFoo() {
|checkNonStaticMethods|true|Check for non-static methods. Do not set this to false and checkNonStaticFields to true.|no|
|checkNonStaticFields|false|Check for non-static fields. Do not set this to true and checkNonStaticMethods to false.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/multithreading.xml/NonThreadSafeSingleton" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/multithreading.xml/NonThreadSafeSingleton">
<properties>
<property name="checkNonStaticMethods" value="true" />
<property name="checkNonStaticFields" value="false" />
</properties>
</rule>
```
## UnsynchronizedStaticDateFormatter
<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f;">Deprecated</span>

22
docs/pages/pmd/rules/java/performance.md
View File

@@ -387,11 +387,20 @@ buf.append("1m"); // good
|----|-------------|-----------|-----------|
|threshold|1|Max consecutive appends|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/performance.xml/ConsecutiveLiteralAppends" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/performance.xml/ConsecutiveLiteralAppends">
<properties>
<property name="threshold" value="1" />
</properties>
</rule>
```
## InefficientEmptyStringCheck
**Since:** PMD 3.6
@@ -800,11 +809,20 @@ public class Foo {
|----|-------------|-----------|-----------|
|minimumNumberCaseForASwitch|3|Minimum number of branches for a switch|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/java/performance.xml/TooFewBranchesForASwitchStatement" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/java/performance.xml/TooFewBranchesForASwitchStatement">
<properties>
<property name="minimumNumberCaseForASwitch" value="3" />
</properties>
</rule>
```
## UnnecessaryWrapperObjectCreation
**Since:** PMD 3.8

24
docs/pages/pmd/rules/plsql/codestyle.md
View File

@@ -81,11 +81,20 @@ END;
|----|-------------|-----------|-----------|
|indentation|2|Indentation to be used for blocks|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/plsql/codestyle.xml/CodeFormat" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/plsql/codestyle.xml/CodeFormat">
<properties>
<property name="indentation" value="2" />
</properties>
</rule>
```
## ForLoopNaming
**Since:** PMD 6.7.0
@@ -145,11 +154,22 @@ END;
|cursorPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the curosr loop variable|no|
|indexPattern|\[a-zA-Z\_0-9\]{5,}|The pattern used for the index loop variable|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/plsql/codestyle.xml/ForLoopNaming" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/plsql/codestyle.xml/ForLoopNaming">
<properties>
<property name="allowSimpleLoops" value="false" />
<property name="cursorPattern" value="[a-zA-Z_0-9]{5,}" />
<property name="indexPattern" value="[a-zA-Z_0-9]{5,}" />
</properties>
</rule>
```
## MisplacedPragma
**Since:** PMD 5.5.2

188
docs/pages/pmd/rules/plsql/design.md
View File

File diff suppressed because it is too large Load Diff

11
docs/pages/pmd/rules/pom/errorprone.md
View File

@@ -50,11 +50,20 @@ The following types are considered valid: pom, jar, maven-plugin, ejb, war, ear,
|----|-------------|-----------|-----------|
|validTypes|pom , jar , maven-plugin , ejb , war , ear , rar , par|Set of valid types.|yes. Delimiter is ','.|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/pom/errorprone.xml/InvalidDependencyTypes" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/pom/errorprone.xml/InvalidDependencyTypes">
<properties>
<property name="validTypes" value="pom,jar,maven-plugin,ejb,war,ear,rar,par" />
</properties>
</rule>
```
## ProjectVersionAsDependencyVersion
**Since:** PMD 5.4

28
docs/pages/pmd/rules/vm/design.md
View File

@@ -25,11 +25,20 @@ Avoid creating deeply nested if-then statements since they are harder to read an
|----|-------------|-----------|-----------|
|problemDepth|3|The if statement depth reporting threshold|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/vm/design.xml/AvoidDeeplyNestedIfStmts" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/vm/design.xml/AvoidDeeplyNestedIfStmts">
<properties>
<property name="problemDepth" value="3" />
</properties>
</rule>
```
## CollapsibleIfStatements
**Since:** PMD 5.1
@@ -59,15 +68,24 @@ The template is too long. It should be broken up into smaller pieces.
|Name|Default Value|Description|Multivalued|
|----|-------------|-----------|-----------|
|topscore||Top score value|no|
|minimum||Minimum reporting threshold|no|
|sigma||Sigma value|no|
|topscore||<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Top score value|no|
|minimum|1000.0|Minimum reporting threshold|no|
|sigma||<span style="border-radius: 0.25em; color: #fff; padding: 0.2em 0.6em 0.3em; display: inline; background-color: #d9534f; font-size: 75%;">Deprecated</span> Sigma value|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/vm/design.xml/ExcessiveTemplateLength" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/vm/design.xml/ExcessiveTemplateLength">
<properties>
<property name="minimum" value="1000.0" />
</properties>
</rule>
```
## NoInlineJavaScript
**Since:** PMD 5.1

11
docs/pages/pmd/rules/xsl/performance.md
View File

@@ -50,8 +50,17 @@ cutting through 100% of the document.
|----|-------------|-----------|-----------|
|checkSelfDescendantAbreviation|false|descendant::self abreviation, '//', will also trigger this rule.|no|
**Use this rule by referencing it:**
**Use this rule with the default properties by just referencing it:**
``` xml
<rule ref="category/xsl/performance.xml/AvoidAxisNavigation" />
```
**Use this rule and customize it:**
``` xml
<rule ref="category/xsl/performance.xml/AvoidAxisNavigation">
<properties>
<property name="checkSelfDescendantAbreviation" value="false" />
</properties>
</rule>
```