You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@ignite.apache.org by " Kirill Sizov (Jira)" <ji...@apache.org> on 2023/11/28 11:17:00 UTC

[jira] [Created] (IGNITE-20982) Add checks to cover comments style

 Kirill Sizov created IGNITE-20982:
--------------------------------------

             Summary:  Add checks to cover comments style
                 Key: IGNITE-20982
                 URL: https://issues.apache.org/jira/browse/IGNITE-20982
             Project: Ignite
          Issue Type: Task
            Reporter:  Kirill Sizov


The following rules help with javadoc comments
{code}
<module name="JavadocStyle"/>
<module name="JavadocMissingWhitespaceAfterAsterisk"/>
{code}
Apart from that we want to check the style of ordinary java comments (start with //).
Common rule: 
- A space between // and the beginning of a sentence
- The sentence starts with a capital letter.
- The sentence/paragraph ends with a period.
See https://cwiki.apache.org/confluence/display/IGNITE/Java+Code+Style+Guide for details



--
This message was sent by Atlassian Jira
(v8.20.10#820010)