mirror of
https://github.com/github/codeql.git
synced 2025-12-16 16:53:25 +01:00
46 lines
1.2 KiB
XML
46 lines
1.2 KiB
XML
<!DOCTYPE qhelp PUBLIC
|
|
"-//Semmle//qhelp//EN"
|
|
"qhelp.dtd">
|
|
<qhelp>
|
|
|
|
|
|
<overview>
|
|
<p>
|
|
A public method or constructor that does not have a Javadoc tag for each parameter
|
|
makes an API more difficult to understand and maintain.</p>
|
|
|
|
</overview>
|
|
<recommendation>
|
|
|
|
<p>The Javadoc comment for a method or constructor should include a Javadoc tag element that
|
|
describes each parameter.</p>
|
|
|
|
</recommendation>
|
|
<example>
|
|
|
|
<p>The following example shows a good Javadoc comment, which clearly explains the method's
|
|
parameter.</p>
|
|
|
|
<sample src="MissingJavadocMethods.java" />
|
|
|
|
</example>
|
|
<references>
|
|
|
|
|
|
<li>
|
|
J. Bloch, <em>Effective Java (second edition)</em>, Item 44.
|
|
Addison-Wesley, 2008.
|
|
</li>
|
|
<li>
|
|
Help - Eclipse Platform:
|
|
<a href="http://help.eclipse.org/indigo/topic/org.eclipse.jdt.doc.user/reference/preferences/java/compiler/ref-preferences-javadoc.htm">Java Compiler Javadoc Preferences</a>.
|
|
</li>
|
|
<li>
|
|
Java SE Documentation:
|
|
<a href="http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html">How to Write Doc Comments for the Javadoc Tool</a>,
|
|
<a href="http://www.oracle.com/technetwork/java/javase/documentation/index-142372.html">Requirements for Writing Java API Specifications</a>.
|
|
</li>
|
|
|
|
</references>
|
|
</qhelp>
|