ParameterComment
Non-standard parameter comment; prefer `/*paramName=*/ arg`

Category
Severity
SUGGESTION
Maturity

The problem

When documenting the name of the corresponding formal parameter for a method argument, prefer the f(/* foo= */ value) style of comment.

The problem with e.g. f(false /* exclusive */) is it can be interpreted multiple ways:

TIP: When you feel the need to add a parameter comment, consider whether the API could be changed to be more self-documenting.

Suppression

Suppress false positives by adding an @SuppressWarnings("ParameterComment") annotation to the enclosing element.