DeepSource
Dashboard Resources Pricing Discover Directory Log in

Run your first analysis.

Find thousands of code security and quality issues in your codebase, before they end up in production.

Start now
Java

Java

Made by DeepSource
Use Analyzer

JavaDoc tags should not be empty JAVA-D1006

Documentation
Major

Empty JavaDoc tags are meaningless, and may even cause tools that consume JavaDoc comments to crash.

Always add an explanation when writing JavaDoc tags.

Bad Practice

In the example below, the @param JavaDoc tag does not refer to any parameter, and does not have any description. This may be because the documentation comment itself is incomplete.

/**
 * Some method.
 *
 * @param
 */
String someMethod(int someParam) {
    // ...

Recommended

Avoid leaving JavaDoc tags without any associated info or description.

/**
 * Some method.
 *
 * @param someParam - Specifies something.
 */
String someMethod(int someParam) {
    // ...

References