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