[
https://issues.apache.org/jira/browse/IGNITE-20982?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17818712#comment-17818712
]
Viacheslav Blinov commented on IGNITE-20982:
--------------------------------------------
Due to lots of comments like visual separators like // ---- and commented code
pieces like //.addOption("opt") and limitations of the only Checkstyle rule
which allows to check commens (TodoRule) stopped at implementing a very basic
requirement that all comments (with a few exclusions) should start with space.
List of exclusions are:
* //CHECKSTYLE:ON – which is the first statement that checkstyle checks after
being enabled again
* //---, /=== – visual headings, separator style comments, which are used in
tests and examples
> 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
> Priority: Major
> Labels: ignite-3
>
> 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)
