Skip to content

new check: JavadocMissingLeadingAsteriskCheck #6722

@pbludov

Description

@pbludov

Checks that each doc comment line start with the asterisk symbol (*)

Rationale: messy comments usually indicates a write-only code. At the very least, they should be arranged.

/**
  * OK
  */

/**
 ** OK
 *
    violation
 **/

/** Some text spawn
     multiple lines */      // violation

Even for code blocks:
/**
 * {@code
 *  int foo; // OK
    int bar; // violation
    }   // violation
 */

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions