Analysis of asdoc-asdoc tags parameters in flex SDK 4 (gumbo)

Source: Internet
Author: User

The flex SDK 4 (gumbo) analysis asdoc-flash Builder 4 configuration section describes how to configure and run asdoc in Flash Builder 4.
This article introduces some commonly used asdoc tags. Only by figuring out how to use asdoc tags can we generate some desired asdoc documents.

Here I only list some commonly used asdoc tags:

@ Param paramname description
Add comments to function parameters. If there are multiple parameters, write multiple @ Param statements.
For example, @ Param scalex imports the magnification of the X axis.

@ Private
Elements excluded during output. (That is, asdoc does not parse and display content containing @ private)

@ Return description
Add description information for the return value of the function.
Example: @ return accumulated value

@ See reference [displaytext]
You can use the @ see tag to add a link for inserting 'see more.
See http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff8.html for details
Note: The @ see tag cannot contain HTML format characters.
Example: @ see COM. rianote. Flex. Kui. component. linklabel

@ Default Value
Default Value of a Variable
For example:
@ Default false
@ Default 0 xffffff

@ Example exampletext
Add code instances for customizing style attributes to the header at the specified position
The code must be written in the <listing version = "3.0"> </listing> label.
When the style is not standard, the instance code is first in a gray scroll border
For example:
@ Example the following code sets the volume level for your sound:
<Listing version = "3.0">
VaR mysound: Sound = new sound (); mysound. setvolume (vol_high );
</Listing>

@ Throws package. Class. classname description
Explanation of thrown exceptions
For example, @ throws securityerror local untrusted SWFs may not communicate with the Internet.

@ Eventtype description
Describes an event type.
Example: @ eventtype MX. Events. flexevent. button_down

Official documents about asdoc tags:
Flex SDK 4 (gumbo) official asdoc Tutorial:
Http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff6.html

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.