[
https://issues.apache.org/jira/browse/IGNITE-20982?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17819225#comment-17819225
]
Viacheslav Blinov commented on IGNITE-20982:
--------------------------------------------
For now only enforcement of preceeding space is implemented. Enforcement of
proper paragraph semantics is to be done separately as it's going to be tricky
to implement via existing checkstyle rules. It requires writing a checkstyle
extension, which is a bigger investment.
> 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)
