[IGNITE-20982] Add checks to cover comments style

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 3.0
• Labels: ignite-3
• Ignite Flags: Docs Required, Release Notes Required
• Assignee: Viacheslav Blinov
• Reporter: Kirill Sizov
• Created: 28/Nov/23 11:16
• Updated: 04/Sep/24 16:08
• Resolved: 29/Feb/24 11:17

Description

The following rules help with javadoc comments

<module name="JavadocStyle"/>
<module name="JavadocMissingWhitespaceAfterAsterisk"/>

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

Issue Links

• is fixed by: IGNITE-21467 Improve PMD and Checkstyle rulesets
• relates to: IGNITE-21581 Add checks to cover sentence semantics checks in code comments