ScriptDoc tag quick reference

This page provides an at-a-glance reference for the tags for the Studio ScriptDoc system. For comprehensive ScriptDoc tag information, including syntax and examples, see the ScriptDoc (SDOC) 2.0 Specification page.

Reference

Tag	Recognized	Affects Content Assist	Description
@alias			ID for a class or function.
@author			Author of a JavaScript file or function.
@classDescription			Description of the class (if applicable).
@constructor			It signifies that a function is a constructor for a class.
@deprecated			It signifies that a function or a property has been deprecated.
@example			Gives an example of the function being documented.
@exception			Specifies the type of exception thrown by a function.
@id			Unique identifier for a function or property.
@inherits			Indicated one "class" derives from another.
@internal			Specifies that a function or property should not be made visible by Content Assist.
@memberOf			It signifies that a function is a member of the specified class.
@method			It signifies that a function is a method of a class, if applicable.
@namespace			Creates the link between the namespace of a library file and an external .sdoc file.
@native			Specifies that a function or property is a native function or property.</td>
@param			Use @param to tag each parameter for a function.
@private			It signifies that a class or function is private.
@projectDescription			Gives a description of the JavaScript file.
@remarks			Any additional remarks that you want to add about a function or class.
@return			Specifies information about the return value(s) of a function.
@sdoc			Defines the path to an external .sdoc file for a library file.
@see			Links to another related class or function.
@since			Specifies since which version the library, function, or property became valid.
@type			Specifies what data type a property is.
@version			Specifies the version number of the JavaScript file or class.

ScriptDoc tag quick reference

Reference

Related Topics