Please enable JavaScript to use CodeHS

CodeHS Glossary


Javadoc Java

A specific standard for commenting Java programs. Javadoc is a format to follow when commenting in order to clearly explain your code.

Javadoc starts with a /** and ends with a */

Here is the general format for commenting (also known as documenting) a method using the Javadoc format:

/**
 * Description of the method
 * 
 * @param nameOfParameter1   description of parameter
 * @param nameOfParameter2  description of parameter
 * @return description of the return value
 */

When the Javadoc format is used, there is a tool (also called Javadoc) that is able to read through your code and produce nice looking documentation for your code.

Javadoc is a convention to follow. If everyone agrees to use Javadoc when commenting their code, then programmers will be able to read each other’s code more easily.