as3注释

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]

复制内容到剪贴板

代码:

@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; @