Documentation Comments

Comments to be published in the documentation must be entered in the format of block comments that start with /** and end with */.

Documentation comments follow the general form of one or more paragraphs of descriptive text, the first of which is used when a summary is required, followed by special tags. Paragraphs within the descriptive text are marked by a blank line. Documentation tags are placed after the general description, and descriptive text after a tag must be in one paragraph with no blank lines.

For example, a documentation comment to describe the function multiply, which takes two parameters, multiplies them, and returns the result, is structured as follows:

/**
 * Returns the result of in_intA * in_intB.
 *
 * If either parameter is not a number, the result is
 * undefined.
 *
 * @param in_intA Integer the number to be multiplied by
 * in_intB
 * @param in_intB Integer the number to be multiplied by
 * in_intA
 * @type Number the result of in_intA * in_intB
 */
function multiply(in_intA, in_intB) {...

The function is described in two paragraphs. The first is a summary of the functionality. Also described are the names and suggested parameters types, and how to interpret the return value.