errorprone.bugpattern.javadoc.NotJavadoc.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sonar-erroraway-sonar-plugin Show documentation

The newest version!

This comment starts with `/**`, but isn't actually Javadoc.

Javadoc comments
[must precede a class, field, constructor, or method declaration](https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#format).

Using `/**` comments in locations where Javadoc is not supported is confusing
and unnecessary.

Suggested solutions:

*   If the comment is intended to be part of the API documentation, move it to
    the appropriate class, field, constructor, or method declaration.

*   If the comment is intended to be an implementation comment, use a
    single-line `//` or a multi-line `/*` comment instead.

> NOTE: Javadoc must appear before any annotations, or the compiler will fail to
> recognise it as Javadoc. That is, prefer this:
>
> ```java
> /** Might return a frobnicator. */
> @Nullable
> Frobnicator getFrobnicator();
> ```
>
> instead of this:
>
> ```java
> @Nullable
> /** Might return a frobnicator. */
> Frobnicator getFrobnicator();
> ```

## Suppression

Suppress by applying `@SuppressWarnings("NotJavadoc")` to the enclosing element.