Documentation of Variables

To document a variable, describe how and what the variable does, and provide a type so users know the acceptable data type for the variable.

The only documentation tags to be used in a variable comment are @type to specify the typical variable, and @scope to define the visibility of a variable. See Namespace Scope of Entities and the @scope Tag. The tags are optional, but it is recommended to use the @type tag. If the @scope tag is not used the documentation system assumes the variable is not visible outside the current event handler.

Variable documentation comments must be placed immediately before the variable declaration or immediately before the variable in an assignment statement, in which case the variable on the left side of the equals sign is assumed to be the variable that is being documented and the variable name may only have white space before it on the line.

A simple documentation comment for a variable.

/**
 * Points to the BQY Section that contains this shape.
 * objSection can be used to access other shapes within the
 * dashboard section.
 *
 * @type Section
 */
var objCurrentSection = this.Parent

Variable documentation is useful when variables are exposed at a section level or as a property of a class, so they are used outside the event handler in which they are defined.