DocumentJS.tags.param  class     

Adds parameter information.

Use cases:

  1. Common use:

    @params {TYPE} name description

  2. Optional parameters use case:

    @params {TYPE} [name] description

  3. Default value use case:

    @params {TYPE} [name=default] description

Example:

/*
 * Finds an order by id.
 * @param {String} id Order identification number.
 * @param {Date} [date] Filter order search by this date.
 */
 findById: function(id, date) {
     // looks for an order by id
 }   
© Jupiter IT - JavaScriptMVC Training and Support