com.puppycrawl.tools.checkstyle.meta.checks.indentation.CommentsIndentationCheck.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.indentation.CommentsIndentationCheck"
             name="CommentsIndentation"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;p&gt;
 Controls the indentation between comments and surrounding code.
 Comments are indented at the same level as the surrounding code.
 Detailed info about such convention can be found
 &lt;a href="https://checkstyle.org/styleguides/google-java-style-20220203/javaguide.html#s4.8.6.1-block-comment-style"&gt;
 here&lt;/a&gt;
 &lt;/p&gt;</description>
         <properties>
            <property default-value="SINGLE_LINE_COMMENT,BLOCK_COMMENT_BEGIN"
                      name="tokens"
                      type="java.lang.String[]"
                      validation-type="tokenSet">
               <description>tokens to check</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="comments.indentation.block"/>
            <message-key key="comments.indentation.single"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>