Class UncommentedMainCheck

Detects uncommented main methods.

Rationale: A 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. With the exception of the real program entry points, all main methods should be removed or commented out of the sources.

• Property excludedClasses - Specify pattern for qualified names of classes which are allowed to have a main method. Type is java.util.regex.Pattern. Default value is "^$".

To configure the check:

 <module name="UncommentedMain"/>
 

Example:

 public class Game {
    public static void main(String... args){}   // violation
 }

 public class Main {
    public static void main(String[] args){}   // violation
 }

 public class Launch {
    //public static void main(String[] args){} // OK
 }

 public class Start {
    public void main(){}                       // OK
 }

 public record MyRecord1 {
    public void main(){}                       // violation
 }

 public record MyRecord2 {
    //public void main(){}                       // OK
 }

 

To configure the check to allow the main method for all classes with "Main" name:

 <module name="UncommentedMain">
   <property name="excludedClasses" value="\.Main$"/>
 </module>
 

Example:

 public class Game {
    public static void main(String... args){}   // violation
 }

 public class Main {
    public static void main(String[] args){}   // OK
 }

 public class Launch {
    //public static void main(String[] args){} // OK
 }

 public class Start {
    public void main(){}                       // OK
 }

 public record MyRecord1 {
    public void main(){}                       // OK
 }

 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• uncommented.main