touque.ca > Education Commons > Java > Resources > Comments

Documentation

There are three types of Java comments:

  1. Single-line internal documentation†: begin with // and terminate with the end of the line.
  2. Multiple-line internal documentation: begin with /* and end with */.
  3. Javadoc: begin with /** and end with */.

Internal documentation†

Javadoc


In our course, we usually refer to internal-documentation comments simply as “comments.”

touque.ca > Education Commons > Java > Resources > Comments

[This page last updated 2020-12-23 at 12h13 Toronto local time.]