com.puppycrawl.tools.checkstyle.meta.checks.coding.ConstructorsDeclarationGroupingCheck.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: 8.8

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.coding.ConstructorsDeclarationGroupingCheck"
             name="ConstructorsDeclarationGrouping"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;div&gt;
 Checks that all constructors are grouped together.
 If there is any non-constructor code separating constructors,
 this check identifies and logs a violation for those ungrouped constructors.
 The violation message will specify the line number of the last grouped constructor.
 Comments between constructors are allowed.
 &lt;/div&gt;

 &lt;p&gt;
 Rationale: Grouping constructors together in a class improves code readability
 and maintainability. It allows developers to easily understand
 the different ways an object can be instantiated
 and the tasks performed by each constructor.
 &lt;/p&gt;</description>
         <message-keys>
            <message-key key="constructors.declaration.grouping"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>