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

Go to download


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 {
            }
        }