
265ADOBE FLEX 3
Building and Deploying Adobe Flex 3 Applications
Placing ASDoc comments
Place an ASDoc comment immediately before the declaration for a class, interface, constructor, method, property,
or metadata tag that you want to document, as the following example shows for the
myMethod() method:
/**
* This is the typical format of a simple
* multiline (single paragraph) main description
* for the myMethod() method, which is declared in
* the ActionScript code below.
* Notice the leading asterisks and single white space
* following each asterisk.
*/
public function myMethod(param1:String, param2:Number):Boolean {}
The ASDoc tool ignores comments p ...