Deprecate the three rules *CyclomaticComplexity (java-codesize)

Refs #445
This commit is contained in:
Andreas Dangel
2017-06-24 10:59:05 +02:00
parent 63f7fe264a
commit 0289fef501
2 changed files with 12 additions and 3 deletions

View File

@ -148,7 +148,8 @@ public class Foo {
since="1.03"
message = "The {0} ''{1}'' has a Cyclomatic Complexity of {2}."
class="net.sourceforge.pmd.lang.java.rule.codesize.CyclomaticComplexityRule"
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#CyclomaticComplexity">
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#CyclomaticComplexity"
deprecated="true">
<description>
<![CDATA[
Complexity directly affects maintenance costs is determined by the number of decision points in a method
@ -204,7 +205,8 @@ public class Foo { // This has a Cyclomatic Complexity = 12
since="5.1.2"
message = "The {0} ''{1}'' has a Standard Cyclomatic Complexity of {2}."
class="net.sourceforge.pmd.lang.java.rule.codesize.StdCyclomaticComplexityRule"
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#StdCyclomaticComplexity">
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#StdCyclomaticComplexity"
deprecated="true">
<description>
<![CDATA[
Complexity directly affects maintenance costs is determined by the number of decision points in a method
@ -260,7 +262,8 @@ public class Foo { // This has a Cyclomatic Complexity = 12
since="5.1.2"
message = "The {0} ''{1}'' has a Modified Cyclomatic Complexity of {2}."
class="net.sourceforge.pmd.lang.java.rule.codesize.ModifiedCyclomaticComplexityRule"
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#ModifiedCyclomaticComplexity">
externalInfoUrl="${pmd.website.baseurl}/rules/java/codesize.html#ModifiedCyclomaticComplexity"
deprecated="true">
<description>
<![CDATA[
Complexity directly affects maintenance costs is determined by the number of decision points in a method

View File

@ -12,6 +12,7 @@ This is a minor release.
* [Java Type Resolution](#Java_Type_Resolution)
* [Metrics Framework](#Metrics_Framework)
* [Modified Rules](#Modified_Rules)
* [Deprecated Rules](#Deprecated_Rules)
* [Fixed Issues](#Fixed_Issues)
* [API Changes](#API_Changes)
* [External Contributions](#External_Contributions)
@ -63,6 +64,11 @@ is not finalized yet and is expected to change.
setting it to `^(ignored|expected)$` would ignore all empty catch blocks where the catched exception is named
either `ignored` or `expected`. The default ignores no exceptions, being backwards compatible.
#### Deprecated Rules
* The three complexity rules `CyclomaticComplexity`, `StdCyclomaticComplexity`, `ModifiedCyclomaticComplexity` (ruleset java-codesize) have been deprecated. They will be eventually replaced
by a new CyclomaticComplexity rule based on the metrics framework. See also [issue #445](https://github.com/pmd/pmd/issues/445).
### Fixed Issues
* General