Java Reference
In-Depth Information
You should use doc comments to document all members, including
private and package-accessible ones. Documentation generators such
as
javadoc
let you specify whether you want to generate documentation
from these comments. Having organized, readable documentation of
your class's internals is quite useful when someone else needs to learn
about them.
On the following two pages, you can see how the generated
HTML
javadoc
output might look for this class.