Skip to content

Supported ScriptDoc Tags

thelonious edited this page Sep 13, 2010 · 3 revisions

text – free-form text
namespace – one or more JS identifiers, separated by periods, ‘.’
type – a fully qualified type, typically a namespace plus the name of a constructor (or the equivalent)
? – the preceding item is optional
+ – the preceding item can be repeated, using a pipe, ‘|’, or comma, ‘,’, as delimiters

  • @advanced text?
  • @alias text
  • @author text
  • @classDescription ‘{’ namespace ‘}’ text
  • @constructor text?
  • @example text
  • @exception ‘{’ type+ ‘}’ text?
  • @extends ‘{’ type+ ‘}’ text?
  • @internal text?
  • @method text?
  • @namespace ‘{’ namespace ‘}’ text?
  • @overview text
  • @param ‘{’ type+ ‘}’ parameterName text?
  • @private text?
  • @property ‘{’ type+ ‘}’ text?
  • @return ‘{’ type ‘}’ text?
  • @see text
  • unknown-tag text?

Any other tag, essentially an at-sign, ‘@’, followed by a valid JS identifier, will be skipped by the parser.

Clone this wiki locally