[
https://issues.apache.org/jira/browse/IGNITE-20982?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17790502#comment-17790502
]
Kirill Sizov commented on IGNITE-20982:
----------------------------------------
As per [~rpuch],
{quote}
About one-line comments: there is a specific use case when we write
parameterized tests which are parameterized with an enum, so we have something
like
enum {
A(…),
B(…),
C(…)
}
Then, it turns out that for B the test is flaky (but not for other members), so
we comment B out with a TODO:
enum {
A(…),
// TODO: IGNITE-XXX fix this.
//B(…),
C(…)
}
Here, the line with commented-out B does not end with a period, so it seems to
violate your suggestion about one-line comments. Is it possible to address
this, or we’ll have to add an artificial period?
{quote}
> 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)
