Javadoc is the de facto standard for generating documentation from source code. It's a tool to
create HTML documentation from specially formatted comments in Java code. This can be used
to generate structured application programming interface (API) documentation automatically,
give some hints to the IDE or for attribution of packages, classes and methods. Essentially, it's a
way of commenting on parameter descriptions, who wrote what, and who to blame if it breaks.
Java comes with the javadoc command-line program to generate the HTML documentation, but
most Java integrated development environments (IDEs) also have this integrated.

Create special javadoc comments. To denote a javadoc comment, start the comment with /**.
Javadoc comments usually exist at the top of a file, before classes and before methods. Since it's
designed for full API documentation, it's not uncommon to see files with more javadoc
comments than code.<code>""/**<br /> * This is a javadoc comment. It doesn't have any
javadoc meta-tags yet, but it did trigger the javadoc parser to take a look at this comment.<br />
*/""</code>

Add API meta-tags (tags that describe the API itself) when commenting. API tags are parameter
names, descriptions, exception profiles, return value descriptions, method names and method
descriptions. Many IDEs incorporate this data into their tool tips and other helpers, as well as it
being for use in HTML or comment form.