ASDoc

Documentation comments use the format /** */, with lines optionally beginning with *.

Supported tags

@copy

Copies documentation comment from another definition. Use a #x component to refer to an instance property.

@copy A
@copy A.w
@copy A#x
@copy #x

@deprecated

@deprecated [Description]

@internal

Internal comment for an item (not included in the generated documentation).

@internal Comment.

@inheritDoc

Inherits documentation from base class or base class's item.

@inheritDoc

@see

Where item maybe an item reference with optional #x instance property, or just an instance property #x.

@see item [Display text]

@param

@param paramName Description

@private

Hides an item from the generated documentation.

@private

@return

@return Description

@throws

@throws ClassName [Description]