Files
openide/java/java-impl/resources/inspectionDescriptions/DanglingJavadoc.html
Leonid Shalupov 40795fe787 IJI-2422: community/java: move resources under resources root
GitOrigin-RevId: 8b2b63fc6db476ca0c2cfe5cadd84db6c4236d0f
2025-02-05 04:43:28 +00:00

33 lines
841 B
HTML

<html>
<body>
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.
<p><b>Example:</b></p>
<pre><code>
class A {
/**
* Dangling comment
*/
/**
* Method javadoc
*/
public void m(){}
}
</code></pre>
<p>A quick-fix is available to delete such comments completely or convert them into a block comment. After the quick-fix is applied:</p>
<pre><code>
class A {
/*
Dangling comment
*/
/**
* Method javadoc
*/
public void m(){}
}
</code></pre>
<!-- tooltip end -->
<p>Use the <b>Ignore file header comment in JavaDoc format</b> option to ignore comments at the beginning of Java files.
These are usually copyright messages.
</body>
</html>