hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=3262.1
TRAVIS_COMMIT_RANGE=8558cdc5b199...4354baacafaa
This commit is contained in:
Travis CI (pmd-bot)
2019-01-09 00:01:31 +00:00
parent 4354baacaf
commit efdd9049e3
3 changed files with 46 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/pages/pmd/rules/java.md
View File

@ -62,7 +62,7 @@ folder: pmd/rules
{% include callout.html content="Rules which enforce a specific coding style." %}
* [AbstractNaming](pmd_rules_java_codestyle.html#abstractnaming): <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> Abstract classes should be named 'AbstractXXX'.
* [AbstractNaming](pmd_rules_java_codestyle.html#abstractnaming): <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> Abstract classes should be named 'AbstractXXX'.This rule is deprecated and will be removed with P...
* [AtLeastOneConstructor](pmd_rules_java_codestyle.html#atleastoneconstructor): Each non-static class should declare at least one constructor.Classes with solely static members ...
* [AvoidDollarSigns](pmd_rules_java_codestyle.html#avoiddollarsigns): Avoid using dollar signs in variable/method/class/interface names.
* [AvoidFinalLocalVariable](pmd_rules_java_codestyle.html#avoidfinallocalvariable): Avoid using final local variables, turn them into fields.

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

@ -19,6 +19,9 @@ language: Java
Abstract classes should be named 'AbstractXXX'.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by {% rule java/codestyle/ClassNamingConventions %}.
**This rule is defined by the following XPath expression:**
``` xpath
//ClassOrInterfaceDeclaration
@ -152,6 +155,9 @@ Prefixing parameters by 'in' or 'out' pollutes the name of the parameters and re
To indicate whether or not a parameter will be modify in a method, its better to document method
behavior with Javadoc.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the more general rule {% rule java/codestyle/FormalParameterNamingConventions %}.
**This rule is defined by the following XPath expression:**
``` xpath
//MethodDeclaration/MethodDeclarator/FormalParameters/FormalParameter/VariableDeclaratorId[
@ -859,6 +865,9 @@ Avoid using 'for' statements without using curly braces. If the code formatting
indentation is lost then it becomes difficult to separate the code being controlled
from the rest.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/codestyle/ControlStatementBraces %}.
**This rule is defined by the following XPath expression:**
``` xpath
//ForStatement[not(Statement/Block)]
@ -1020,6 +1029,9 @@ Avoid using if..else statements without using surrounding braces. If the code fo
or indentation is lost then it becomes difficult to separate the code being controlled
from the rest.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/codestyle/ControlStatementBraces %}.
**This rule is defined by the following XPath expression:**
``` xpath
//Statement
@ -1058,6 +1070,9 @@ Avoid using if statements without using braces to surround the code block. If th
formatting or indentation is lost then it becomes difficult to separate the code being
controlled from the rest.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/codestyle/ControlStatementBraces %}.
**This rule is defined by the following XPath expression:**
``` xpath
//IfStatement[count(*) < 3][not(Statement/Block)]
@ -1466,6 +1481,10 @@ public class Foo {
Detects when a non-field has a name starting with 'm_'. This usually denotes a field and could be confusing.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the more general rule
{% rule java/codestyle/LocalVariableNamingConventions %}.
**This rule is defined by the following XPath expression:**
``` xpath
//VariableDeclaratorId
@ -1806,6 +1825,9 @@ public class Something {
Field names using all uppercase characters - Sun's Java naming conventions indicating constants - should
be declared as final.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the more general rule {% rule java/codestyle/FieldNamingConventions %}.
**This rule is defined by the following XPath expression:**
``` xpath
//ClassOrInterfaceDeclaration[@Interface='false']
@ -2316,6 +2338,11 @@ A variable naming conventions rule - customize this to your liking. Currently,
checks for final variables that should be fully capitalized and non-final variables
that should not include underscores.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the more general rules {% rule java/codestyle/FieldNamingConventions %},
{% rule java/codestyle/FormalParameterNamingConventions %}, and
{% rule java/codestyle/LocalVariableNamingConventions %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.codestyle.VariableNamingConventionsRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/codestyle/VariableNamingConventionsRule.java)
**Example(s):**
@ -2362,6 +2389,9 @@ Avoid using 'while' statements without using braces to surround the code block.
formatting or indentation is lost then it becomes difficult to separate the code being
controlled from the rest.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/codestyle/ControlStatementBraces %}.
**This rule is defined by the following XPath expression:**
``` xpath
//WhileStatement[not(Statement/Block)]

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

@ -987,6 +987,9 @@ Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate c
high complexity, and 11+ is very high complexity. Modified complexity treats switch statements as a single
decision point.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/design/CyclomaticComplexity %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.ModifiedCyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/ModifiedCyclomaticComplexityRule.java)
**Example(s):**
@ -1055,6 +1058,9 @@ This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determin
of code for a given constructor. NCSS ignores comments, and counts actual statements. Using this algorithm,
lines of code that are split are counted as one.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/design/NcssCount %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.NcssConstructorCountRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/NcssConstructorCountRule.java)
**Example(s):**
@ -1155,6 +1161,9 @@ This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determin
of code for a given method. NCSS ignores comments, and counts actual statements. Using this algorithm,
lines of code that are split are counted as one.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/design/NcssCount %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.NcssMethodCountRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/NcssMethodCountRule.java)
**Example(s):**
@ -1200,6 +1209,9 @@ This rule uses the NCSS (Non-Commenting Source Statements) algorithm to determin
of code for a given type. NCSS ignores comments, and counts actual statements. Using this algorithm,
lines of code that are split are counted as one.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/design/NcssCount %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.NcssTypeCountRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/NcssTypeCountRule.java)
**Example(s):**
@ -1599,6 +1611,9 @@ plus one for the method entry. The decision points include 'if', 'while', 'for'
Generally, numbers ranging from 1-4 denote low complexity, 5-7 denote moderate complexity, 8-10 denote
high complexity, and 11+ is very high complexity.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the rule {% rule java/design/CyclomaticComplexity %}.
**This rule is defined by the following Java class:** [net.sourceforge.pmd.lang.java.rule.design.StdCyclomaticComplexityRule](https://github.com/pmd/pmd/blob/master/pmd-java/src/main/java/net/sourceforge/pmd/lang/java/rule/design/StdCyclomaticComplexityRule.java)
**Example(s):**