com.puppycrawl.tools.checkstyle.meta.checks.UncommentedMainCheck.xml Maven / Gradle / Ivy

Go to download

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

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 10.20.1

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck"
             name="UncommentedMain"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;p&gt;
 Detects uncommented {@code main} methods.
 &lt;/p&gt;
 &lt;p&gt;
 Rationale: A {@code main} method is often used for debugging purposes.
 When debugging is finished, developers often forget to remove the method,
 which changes the API and increases the size of the resulting class or JAR file.
 Except for the real program entry points, all {@code main} methods
 should be removed or commented out of the sources.
 &lt;/p&gt;</description>
         <properties>
            <property default-value="^$"
                      name="excludedClasses"
                      type="java.util.regex.Pattern">
               <description>Specify pattern for qualified names of
 classes which are allowed to have a {@code main} method.</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="uncommented.main"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>