Dangling Javadoc comment
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(){}
}
- 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.
DanglingJavadoc
Use the Ignore file header comment in JavaDoc format option to ignore comments at the beginning of Java files. These are usually copyright messages.
Here you can find the description of settings available for the Dangling Javadoc comment inspection, and the reference of their default values.
Inspection Details | |
---|---|
By default bundled with: | |
Can be installed with plugin: | Java, 243.23126 |
Thanks for your feedback!