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

Comment cleanup for bug #1512374

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@4649 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Brian Remedios
2006-10-14 16:15:01 +00:00
parent 80c477cb32
commit e31e3387e5
8 changed files with 31 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
pmd/rulesets/basic-jsp.xml
View File

@ -89,7 +89,7 @@ response.setHeader("Pragma", "No-cache");
class="net.sourceforge.pmd.jsp.rules.NoInlineStyleInformation"
externalInfoUrl="http://pmd.sourceforge.net/rules/basic-jsp.html#NoInlineStyleInformation">
<description><![CDATA[ Style information should be put in CSS files, not in JSPs.
Therefore, don't use <B> or <FONT> tags, or attributes like "align='center'" ]]> </description>
Therefore, don't use <B> or <FONT> tags, or attributes like "align='center'". ]]> </description>
<priority>3</priority>
<example>
<![CDATA[

8
pmd/rulesets/braces.xml
View File

@ -14,7 +14,7 @@ The Braces Ruleset contains a collection of braces rules.
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/braces.html#IfStmtsMustUseBraces">
<description>
Avoid using if statements without using curly braces
Avoid using if statements without using curly braces.
</description>
<properties>
<property name="xpath">
@ -44,7 +44,7 @@ Avoid using if statements without using curly braces
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/braces.html#WhileLoopsMustUseBraces">
<description>
Avoid using 'while' statements without using curly braces
Avoid using 'while' statements without using curly braces.
</description>
<properties>
<property name="xpath">
@ -72,7 +72,7 @@ public void doSomething() {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/braces.html#IfElseStmtsMustUseBraces">
<description>
Avoid using if..else statements without using curly braces
Avoid using if..else statements without using curly braces.
</description>
<properties>
<property name="xpath">
@ -108,7 +108,7 @@ Avoid using if..else statements without using curly braces
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/braces.html#ForLoopsMustUseBraces">
<description>
Avoid using 'for' statements without using curly braces
Avoid using 'for' statements without using curly braces.
</description>
<properties>
<property name="xpath">

6
pmd/rulesets/clone.xml
View File

@ -14,7 +14,7 @@ The Clone Implementation ruleset contains a collection of rules that find questi
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/clone.html#ProperCloneImplementation">
<description>
Object clone() should be implemented with super.clone()
Object clone() should be implemented with super.clone().
</description>
<properties>
<property name="xpath">
@ -51,7 +51,7 @@ class Foo{
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/clone.html#CloneThrowsCloneNotSupportedException">
<description>
The method clone() should throw a CloneNotSupportedException
The method clone() should throw a CloneNotSupportedException.
</description>
<properties>
<property name="xpath">
@ -89,7 +89,7 @@ and count(NameList/Name[contains
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/clone.html#CloneMethodMustImplementCloneable">
<description>
The method clone() should only be implemented if the class implements the Cloneable interface with the exception of a final method that only throws CloneNotSupportedException
The method clone() should only be implemented if the class implements the Cloneable interface with the exception of a final method that only throws CloneNotSupportedException.
</description>
<properties>
<property name="xpath">

4
pmd/rulesets/controversial.xml
View File

@ -322,7 +322,7 @@ making them look like a function call.
class="net.sourceforge.pmd.rules.SingularField"
externalInfoUrl="http://pmd.sourceforge.net/rules/controversial.html#SingularField">
<description>
A field that's only used by one method could perhaps be replaced by a local variable
A field that's only used by one method could perhaps be replaced by a local variable.
</description>
<priority>3</priority>
<example>
@ -344,7 +344,7 @@ public class Foo {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/controversial.html#DefaultPackage">
<description>
Use explicit scoping instead of the default package private level
Use explicit scoping instead of the default package private level.
</description>
<properties>
<property name="xpath">

2
pmd/rulesets/coupling.xml
View File

@ -15,7 +15,7 @@
class="net.sourceforge.pmd.rules.CouplingBetweenObjects"
externalInfoUrl="http://pmd.sourceforge.net/rules/coupling.html#CouplingBetweenObjects">
<description>
Rule counts unique attributes, local variables and return types within an object. An amount
This rule counts unique attributes, local variables and return types within an object. A number
higher than specified threshold can indicate a high degree of coupling.
</description>
<priority>3</priority>

35
pmd/rulesets/design.xml
View File

@ -37,7 +37,7 @@ public class MaybeASingleton {
class="net.sourceforge.pmd.rules.SimplifyBooleanReturns"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#SimplifyBooleanReturns">
<description>
Avoid unnecessary if..then..else statements when returning a boolean
Avoid unnecessary if..then..else statements when returning a boolean.
</description>
<priority>3</priority>
<example>
@ -64,7 +64,7 @@ public class Foo {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#SimplifyBooleanExpressions">
<description>
Avoid unnecessary comparisons in boolean expressions - this makes simple code seem complicated.
Avoid unnecessary comparisons in boolean expressions - this complicates simple code.
</description>
<properties>
<property name="xpath">
@ -175,7 +175,7 @@ public class Foo {
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#SwitchDensity">
<description>
A high ratio of statements to labels in a switch statement implies that the switch
statement is doing too much work. Consider moving the statements either into new
statement is doing too much work. Consider moving the statements into new
methods, or creating subclasses based on the switch variable.
</description>
<priority>3</priority>
@ -207,13 +207,13 @@ public class Foo {
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#ConstructorCallsOverridableMethod">
<description>
Calling overridable methods during construction poses a risk of invoking methods on an
incompletely constructed object. This situation can be difficult to discern.
incompletely constructed object and can be difficult to discern.
It may leave the sub-class unable to construct its superclass or forced to
replicate the construction process completely within itself, losing the ability to call
super(). If the default constructor contains a call to an overridable method,
the subclass may be completely uninstantiable. Note that this includes method calls
throughout the control flow graph - i.e., if a constructor Foo() calls a private method
bar() that calls a public method buz(), there's a problem.
bar() that calls a public method buz(), this denotes a problem.
</description>
<priority>1</priority>
<example>
@ -249,7 +249,7 @@ Instantiation by way of private constructors from outside of the constructor's c
A factory method, or non-privitization of the constructor can eliminate this situation.
The generated class file is actually an interface. It gives the accessing class the ability to invoke a new hidden package
scope constructor that takes the interface as a supplementary parameter. This turns a private constructor effectively into
one with package scope, though not visible to the naked eye.
one with package scope, and is challenging to discern.
</description>
<priority>3</priority>
<example>
@ -272,7 +272,7 @@ public class Outer {
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#FinalFieldCouldBeStatic">
<description>
If a final field is assigned to a compile-time constant, it could be
made static, thus saving overhead in each object
made static, thus saving overhead in each object at runtime.
</description>
<properties>
<property name="xpath">
@ -303,7 +303,7 @@ public class Foo {
class="net.sourceforge.pmd.rules.CloseResource"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#CloseResource">
<description>
Ensure that resources (like Connection, Statement, and ResultSet objects) are always closed after use
Ensure that resources (like Connection, Statement, and ResultSet objects) are always closed after use.
</description>
<properties>
<property name="types" value="Connection,Statement,ResultSet"/>
@ -477,8 +477,7 @@ class Foo {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#BadComparison">
<description>
Avoid equality comparisons with Double.NaN - these are
likely to be logic errors.
Avoid equality comparisons with Double.NaN - these are likely to be logic errors.
</description>
<properties>
<property name="xpath">
@ -506,7 +505,7 @@ public class Bar {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#EqualsNull">
<description>
Newbie programmers sometimes get the comparison concepts confused
Inexperienced programmers sometimes confuse comparison concepts
and use equals() to compare to null.
</description>
<properties>
@ -573,7 +572,7 @@ public class Foo {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#InstantiationToGetClass">
<description>
Avoid instantiating an object just to call getClass() on it; use the .class public member instead
Avoid instantiating an object just to call getClass() on it; use the .class public member instead.
</description>
<example>
<![CDATA[
@ -603,11 +602,11 @@ public class Foo {
</rule>
<rule name="IdempotentOperations"
message="Avoid idempotent operations (like assigning a variable to itself)"
message="Avoid idempotent operations (like assigning a variable to itself)."
class="net.sourceforge.pmd.rules.IdempotentOperations"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#IdempotentOperations">
<description>
Avoid idempotent operations - they are silly.
Avoid idempotent operations - they are have no effect.
</description>
<priority>3</priority>
@ -1120,8 +1119,8 @@ Avoid unnecessarily creating local variables
class="net.sourceforge.pmd.rules.design.NonThreadSafeSingleton"
externalInfoUrl="http://pmd.sourceforge.net/rules/design.html#NonThreadSafeSingleton">
<description>
Non-thread safe singletons can result in bad state changes. If possible,
get rid of static singletons by directly instantiating the object. Static
Non-thread safe singletons can result in bad state changes. Eliminate
static singletons if possible by instantiating the object directly. Static
singletons are usually not needed as only a single instance exists anyway.
Other possible fixes are to synchronize the entire method or to use an
initialize-on-demand holder class (do not use the double-check idiom).
@ -1275,8 +1274,8 @@ public class Foo {
class="net.sourceforge.pmd.rules.design.PreserveStackTrace">
<description>
Throwing a new exception from a catch block without passing the original exception into the
new Exception will cause the true stack trace to be lost, and can cause problems
debugging problems
new Exception will cause the true stack trace to be lost, and can make it difficult to
debug effectively.
</description>
<properties></properties>
<priority>3</priority>

2
pmd/rulesets/finalizers.xml
View File

@ -107,7 +107,7 @@ public class Foo {
class="net.sourceforge.pmd.rules.XPathRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/finalizers.html#FinalizeDoesNotCallSuperFinalize">
<description>
If the finalize() is implemented, its last action should be to call super.finalize
If the finalize() is implemented, its last action should be to call super.finalize.
</description>
<properties>
<property name="xpath">

4
pmd/rulesets/imports.xml
View File

@ -85,11 +85,11 @@ public class Foo {}
</rule>
<rule name="ImportFromSamePackage"
message="No need to import a type that's in the same package"
message="No need to import a type that lives in the same package"
class="net.sourceforge.pmd.rules.imports.ImportFromSamePackageRule"
externalInfoUrl="http://pmd.sourceforge.net/rules/imports.html#ImportFromSamePackage">
<description>
No need to import a type that's in the same package.
No need to import a type that lives in the same package.
</description>
<priority>3</priority>
<example>