With the introduction of Markdown support in Javadoc comments in Java 23, developers should prefer Markdown syntax over legacy HTML tags (e.g.,
<b>
, <i>
, <code>
, <ul>
, <li>
, etc.) and legacy Javadoc
tags (e.g. {@link java.util.HashMap}
, {@code Object}
).
Mixing HTML and Markdown can lead to readability issues and inconsistencies in rendering across tools. Markdown is generally more readable, less
cluttered and, should be preferred over HTML tags when possible.
This rule will raise an issue when an HTML tag or a legacy Javadoc tag inside a markdown comment could be replaced with a slimmer, and more
cohesive, syntax.