Comment replaceable with Javadoc

Reports a regular comment that belongs to a field, method, or class that can be replaced with a Javadoc comment.

Example:

  public class Main {
    /*
    * Hello,
    */
    // World!
    void f() {
    }
  }

After the quick-fix is applied:

  public class Main {
    /**
     * Hello,
     * World!
     */
    void f() {
    }
  }

Locating this inspection

By ID

Can be used to locate inspection in e.g. Qodana configuration files, where you can quickly enable or disable it, or adjust its settings.

ReplaceWithJavadoc

Via Settings dialog

Path to the inspection settings via IntelliJ Platform IDE Settings dialog, when you need to adjust inspection settings directly from your IDE.

Settings or Preferences | Editor | Inspections | Java | Javadoc

Inspection Details
By default bundled with:	IntelliJ IDEA 2024.2, Qodana for JVM 2024.2,
Can be installed with plugin:	Java, 242.22892

Last modified: 11 September 2024