[Flex]Flex SDK 4(Gumbo)浅析ASDoc - ASDoc Tags参数篇

Flex SDK 4(Gumbo)浅析ASDoc - Flash Builder 4配置篇》介绍了如何在Flash Builder 4里面配置、运行ASDoc
本篇文章介绍一些比较常用的ASDoc Tags,只有搞清楚了如何使用ASDoc Tags才能让我们生成一些我们想要的ASDoc文档。

我在这里只列举了一些比较常用的ASDoc Tags

@param paramName description
为函数的参数添加注释,如果有多个参数,则写入多个@param即可。
例如:@param scaleX 传入x轴方向的放大率

@private
输出时会被排除的元素。(即ASDoc不会解析和显示包含@private的内容)

@return description
为函数的返回值添加描述信息。
例如:@return 累加的值

@see reference [displayText]
用@see标签可以增加插入‘参见更多’的一个链接。
详细请看:http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff8.html
注意:@see标签中不能包含HTML格式化字符。
例如:@see com.rianote.flex.kui.component.LinkLabel

@default value
某个变量的默认值
例如:
@default false
@default 0xffffff

@example exampleText
在指定位置的头部添加可自定义样式属性的代码实例 
代码需要写在<listing version="3.0"></listing>标签内 
不规范样式时,实例代码会被先是在一个灰色可滚动的边框中 
例如:
@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
对抛出的异常进行解释
例如:@throws SecurityError Local untrusted SWFs may not communicate with the Internet.

@eventType description
对某一个Event类型进行描述
例如:@eventType mx.events.FlexEvent.BUTTON_DOWN

关于ASDoc Tags的官方文档:
Flex SDK 4(Gumbo)官方ASDoc教程:
http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ff6.html

Flex 3.x官方ASDoc教程:
http://livedocs.adobe.com/flex/3/html/help.html?content=asdoc_9.html

关于ASDoc中可以使用的HTML标签:
http://livedocs.adobe.com/flex/gumbo/html/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-8000.html