Class JavadocBlockTagLocationCheck

All Implemented Interfaces:
Configurable, Contextualizable

Checks that a javadoc block tag appears only at the beginning of a line, ignoring leading asterisks and white space. A block tag is a token that starts with @ symbol and is preceded by a whitespace. This check ignores block tags in comments and inside inline tags {@code } and {@literal }.

Rationale: according to the specification all javadoc block tags should be placed at the beginning of a line. Tags that are not placed at the beginning are treated as plain text. To recognize intentional tag placement to text area it is better to escape the @ symbol, and all non-escaped tags should be located at the beginning of the line. See NOTE section for details on how to escape.

Notes: To place a tag explicitly as text, escape the @ symbol with HTML entity @ or place it inside {@code }, for example:


 /**
  * @serial literal in {@code @serial} Javadoc tag.
  */
 
Since:
8.24