JavadocMissingWhitespaceAfterAsterisk

Since Checkstyle 8.32

Description

Checks that there is at least one whitespace after the leading asterisk. Although spaces after asterisks are optional in the Javadoc comments, their absence makes the documentation difficult to read. It is the de facto standard to put at least one whitespace after the leading asterisk.

Properties

name description type default value since
violateExecutionOnNonTightHtml Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. boolean false 8.3

Examples

To configure the default check: 

<module name="Checker">
  <module name="TreeWalker">
    <module name="JavadocMissingWhitespaceAfterAsterisk"/>
  </module>
</module>

Code Example: 

/** This is valid single-line Javadoc. */
class Example1 {
  /**
   *This is invalid Javadoc.
   */ // violation above, 'Missing a whitespace after the leading asterisk'
  int invalidJavaDoc;
  /**
   * This is valid Javadoc.
   */
  void validJavaDocMethod() {
  }
  /**This is invalid single-line Javadoc. */
  // violation above, 'Missing a whitespace after the leading asterisk'
  void invalidSingleLineJavaDocMethod() {
  }
  /** This is valid single-line Javadoc. */
  void validSingleLineJavaDocMethod() {
  }
}

Example of Usage

Violation Messages

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.javadoc

Parent Module

TreeWalker