Pattern: Malformed Javadoc block tag position
Issue: -
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.
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.
*/