使用官方ASDoc

本例包括以下內容:
1. 絕大部分ASDoc tags
2. 絕大部分HTML tags and character codes

ASDoc tags

1.@default value    默認值。

2.@eventType package.class.CONSTANT @eventType String

        /**
         * 使用事件的註釋
         * 
         * @eventType flash.events.ProgressEvent.PROGRESS
         */
        [Event(name="progress", type="flash.events.ProgressEvent")]   

3.@example exampleText

@example 下邊是一個例子：
         * <listing version="3.0">
         *         var asDocTest : AsDocTest = new AsDocTest();
         *  asDocTest.msun("test");</listing>

4.@param paramName description 
參數  example: @param needParam 必選參數

5.@return description 
返回值 example: @return 返回參數測試

6.@throws package.class.className description 
拋出錯誤 example:  @throws Error 拋出錯誤註釋

7.@see reference [displayText]

1. @see com.adobe.utils.ArrayUtil

複製代碼

8.@copy reference 
Copies an ASDoc comment from the referenced location. The main description, @param, and @return content is copied; other tags are not copied.
複製一塊註釋從其他位置。The main description, @param, and @return 會被複制，其他的標籤被忽略。

典型的@copy 用法是：從非繼承體系裏的類或接口複製註釋。如果要從繼承體系裏複製註釋就要用@inheritDoc 。如果要加上其他註釋要在@copy 之前。

/**
                 * 一個copy的演示 from com.adobe.utils.ArrayUtil
                 * @copy com.adobe.utils.ArrayUtil
                 */

9.@inheritDoc
當在覆蓋父類方法或屬性時，是用此tag複製超類（接口）裏的註釋。
The main ASDoc comment, @param, and @return內容會被複制，其他tag內容被忽略。
如果要加上其他註釋要在@inheritDoc 之前。

如果有很多超類，ASdoc使用以下規則查找：
1. 當前類實現的接口及超接口。
2. 當前類的父類。
3. 父類實現的接口及超接口。
4. 重複2、3部，直到到達目標類。

注意與@copy的區別。


10.@internal text 
內部註釋，不會在文檔中輸出。與下邊的class="hide"有些相似。

11.@private
排除此tag所在元素（類、屬性、方法...）在輸出的文檔裏。
在類註釋里加上@private，此類將不會在文檔中輸出。
在類的元素（屬性、方法...）注視里加上@private，這些元素將不會在文檔中輸出。

HTML tags 

1.<p></p>  開始一個新段落。看起來有些像HTML中的<br/> 加一個空白行。主要是增加可讀性。

2.class="hide"  隱藏文字。當你想在源代碼中添加註釋但又不想在文檔中輸出就可以使用之。

3.<listing></listing>中間包一段源代碼會有很棒的效果。

4.<ul>, <li> 列表，效果如下。

5.<table> <th> <tr> <td>  表格，效果如下。（<th>是表頭）

6.<img src = "../../images/matrix.jpg" />  插入一副圖片。

7.<strong>  加粗字體。

8.<em> 斜體。

9.&lt; (<) 

10.&gt;  (>)

11.&  (&)

12.~~ (*) 

13.&#x99;  (™)

14.&#xA0;  Nonbreaking space.

15.&#xAE;  (®)

16.&#xB0;  Degree symbol.

17.&#64; @