JavadocEndCommentDelimiter
Since Checkstyle 14.1.0
Description
Checks that the Javadoc closing delimiter contains exactly one asterisk before the slash.
The closing delimiter of a Javadoc comment is */. This check reports Javadoc comments whose closing delimiter is preceded by another asterisk, such as **/ or ***/.
Examples
To configure the check:
<module name="Checker">
<module name="TreeWalker">
<module name="JavadocEndCommentDelimiter"/>
</module>
</module>
Example:
/**
* Valid Javadoc.
*/
class ValidMultiLine {}
/** Valid single-line Javadoc. */
class ValidSingleLine {}
/*
* Normal block comments are ignored.
**/
class BlockComment {}
// violation 4 lines below """Javadoc closing delimiter should contain exactly
// one asterisk."""
/**
* Invalid Javadoc.
**/
class ExtraAsterisk {}
// violation below 'Javadoc closing delimiter should contain exactly one asterisk.'
/** Invalid single-line Javadoc. **/
class SingleLineExtraAsterisk {}
// violation 4 lines below """Javadoc closing delimiter should contain exactly
// one asterisk."""
/**
* Invalid Javadoc.
***/
class MultipleExtraAsterisks {}
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.
Fully Qualified Name
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocEndCommentDelimiterCheck
Use this fully qualified class name in configuration when an exact class reference is required.