Specifications

CHAPTER 13
266
The tag section begins with the first ASDoc tag in the comment, which is defined by the first @ character that
begins a line, ignoring leading asterisks, white space, and the leading separator characters,
/**. The main
description cannot continue after the tag section begins.
The text following an ASDoc tag can span multiple lines. You can have any number of tags, where some tags can
be repeated, such as the
@param and @see tags, while others cannot.
The following example shows an ASDoc comment that includes a main description and a tag section. Notice the
use of white space and leading asterisks to make the comment more readable:
/**
* Typical format of a simple multiline comment.
* This text describes the myMethod() method, which is declared below.
*
* @param param1 Describe param1 here.
* @param param2 Describe param2 here.
*
* @return Describe return value here.
*
* @see someOtherMethod
*/
public function myMethod(param1:String, param2:Number):Boolean {}
For a complete list of the ASDoc tags, see “ASDoc tags” on page 275.
Using the @private tag
By default, the ASDoc tool generates output for all public and protected elements in an ActionScript class, even if
you omit the ASDoc comment. To make ASDoc ignore an element, insert an ASDoc comment that contains the
@private tag anywhere in the comment. The ASDoc comment can contain additional text along with the
@private tag, which is also excluded from the output.
ASDoc also generates output for all public classes in the list of input classes. You can specify to ignore an entire
class by inserting an ASDoc comment that contains the
@private tag before the class definition. The ASDoc
comment can contain additional text along with the
@private tag, which is also excluded from the output.
Excluding an inherited element
By default, the ASDoc tool copies information and a link for all ActionScript elements inherited by a subclass from
a superclass. In some cases, a subclass may not support an inherited element. You can use the
[Exclude] metadata
tag to cause ASDoc to omit the inherited element from the list of inherited elements.
The [Exclude] metadata tag has the following syntax:
[Exclude(name="elementName", kind="property|method|event|style|effect")]