resources.report.rules.pmd.CommentDefaultAccessModifier.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!



CommentDefaultAccessModifier

CommentDefaultAccessModifier



    To avoid mistakes if we want that a Method, Field or Nested class have a default access modifier
    we must add a comment at the beginning of the Method, Field or Nested class.
    By default the comment must be /* default */, if you want another, you have to provide a regex.

This rule is defined by the following Java class: net.sourceforge.pmd.lang.java.rule.comments.CommentDefaultAccessModifierRule
Example(s):


        
        public class Foo {
            final String stringValue = "some string";
            String getString() {
               return stringValue;
            }

            class NestedFoo {
            }
        }

        // should be
        public class Foo {
            /* default */ final String stringValue = "some string";
            /* default */ String getString() {
               return stringValue;
            }

            /* default */ class NestedFoo {
            }
        }