Back to Intellij Community

DanglingJavadoc

java/java-impl/resources/inspectionDescriptions/DanglingJavadoc.html

2025.3-rc-2732 B
Original Source

Reports Javadoc comments that don't belong to any class, method or field. The Javadoc tool ignores dangling Javadoc comments and doesn't include them in the HTML documentation it generates.

Example:

class A {
    /**
     * Dangling comment
     */
    /**
     * Method javadoc
     */
     public void m(){}
  }

A quick-fix is available to delete such comments completely or convert them into a block comment. After the quick-fix is applied:

class A {
    /*
      Dangling comment
    */
    /**
     * Method javadoc
     */
    public void m(){}
  }

Use the Ignore file header comment in JavaDoc format option to ignore comments at the beginning of Java files. These are usually copyright messages.