• Home
• org.codehaus.sonar-plugins.java
• java-checks
• 3.2
• source code
• TrailingCommentCheck.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.sonar.l10n.java.rules.squid.TrailingCommentCheck.html Maven / Gradle / Ivy

This rule verifies that single-line comments are not located at the end of a line of code. The main idea behind this rule is that in order to be really readable, trailing comments would have to be properly written and formatted (correct alignment, no interference with the visual structure of the code, not too long to be visible) but most often, automatic code formatters would not handle this correctly: the code would end up less readable. Comments are far better placed on the previous empty line of code, where they will always be visible and properly formatted.
Noncompliant Code Example

int a1 = b + c; // This is a trailing comment that can be very very long

Compliant Solution

// This very long comment is better placed before the line of code
int a2 = b + c;

Exceptions

By default, the property "legalTrailingCommentPattern" allows to ignore comments containing only one word :
doSomething(); //FIXME