resources.report.rules.pmd.VariableNamingConventions.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sanity4j Show documentation

Sanity4J was created to simplify running multiple static code analysis tools on the Java projects. It provides a single entry point to run all the selected tools and produce a consolidated report, which presents all findings in an easily accessible manner.

The newest version!



VariableNamingConventions


VariableNamingConventions
A variable naming conventions rule - customize this to your liking.  Currently, it
 checks for final variables that should be fully capitalized and non-final variables
 that should not include underscores.
        
		
		
		    
		    
    		    
    		    
    		    

    		    This rule is defined by the following Java class:
    		    net.sourceforge.pmd.rules.VariableNamingConventions
    		    
		    
	    
	    
        
        
        Example:
            
                    

public class Foo {
 public static final int MY_NUM = 0;
 public String myTest = "";
 DataModule dmTest = new DataModule();
}

        
            
  
        

        
        
            
                This rule has the following properties:
                Name Default value Description
                
                
                    

                    staticPrefix
                    
                    A prefix for static variables
                    
                
                    
                    staticSuffix
                    
                    A suffix for static variables
                    
                
                    
                    memberPrefix
                    
                    A prefix for member variables
                    
                
                    
                    memberSuffix
                    
                    A suffix for member variables

Name	Default value	Description
staticPrefix		A prefix for static variables
staticSuffix		A suffix for static variables
memberPrefix		A prefix for member variables
memberSuffix		A suffix for member variables