Thursday, February 10, 2011

How to add comments to AsDoc:

Here is a list of AsDoc tags and the special HTML tags you can use in your code.  But generally it is the standard documentation with extra tags you can use.  Below is an example:





/**
 * This function says hi.
 * 
 * @param  message    the text you wish to be printed.
 *
 * @return   true, if successful; false otherwise.
 */
public function say(message:String) : Boolean
{
     var success:Boolean = false;
     if( message != null )
     {
        trace(message);
        success = true;
     }
     return success;
}

@param is the parameter of the function
@return is of course specify the return type.

Related Links:
AsDoc
special HTML tags

No comments:

Post a Comment