ASDoc生成ActionScript的API类文档.doc

ASDoc生成ActionScript的API类文档注释标签ASDoc tags1.default value 默认值。2.eventType package.class.CONSTANT eventType String/* 使用事件的注释* eventType flash.events.ProgressEvent.PROGRESS*/Event(name=progress, type=flash.events.ProgressEvent)3.example exampleTextexample 下边是一个例子：/* * var asDocTest : AsDocTest = new AsDocTest(); * asDocTest.msun(test); */4.param paramName description参数 example: param needParam 必选参数5.return description返回值 example: return 返回参数测试6.throws package.class.className description抛出错误 example: throws Error 抛出错误注释7.see reference displayTextsee com.adobe.utils.ArrayUtil8.copy referenceCopies 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. 开始一个新段落。看起来有些像HTML中的 加一个空白行。主要是增加可读性。2.class=”hide” 隐藏文字。当你想在源代码中添加注释但又不想在文档中输出就可以使用之。3.中间包一段源代码会有很棒的效果。4., 列表，效果如下。5. 表格，效果如下。（是表头）6. 插入一副图片。7. 加粗字体。8. 斜体。9. ( ()11.& (&)12. (*)13. ()14. Nonbreaking space.15. ()16. Degree symbol.17. 不如用ASDoc 标签 描述实例param paramName description 为函数的参数添加注释。 属性名与函数中的参数名必须匹配param fileName The name of the file to load. private 输出时会被排除的元素. 使用private标签标记在ASDoc命令中不输出的类或某个元素。private return description 为函数的返回值添加描述信息ASDoc 会自动限定返回值的数据类型.return The translated message. see reference displayText 用see标签可以增加插入参见更多的一个链接. 更多信息参见 Using the see tag. 在see标签中不能包含HTML格式化字符see flash.display.MovieClip throws package.class.className description 输出函数能throw的错误 throws SecurityError Local untrusted SWFs may not communicate with the Internet. copy reference从当前文章中拷贝ASDoc命令。 可拷贝param标签和return标签的内容，其它标签不可用. 也可以用copy标签父类或父接口源文件拷贝信息. 如果父类或父接口被继承，用inheritDoc标签代替 也可以在copy标签之前添加内容 see标签也可以用同样的句法 指定位置。更多see标签信息参见Using the see tag /flex/3/html/asdoc_7.html#188433copy #stopcopy MovieClip#stop default value为 property, style或 effect指定默认值. 当ASDoc检测到default标签后会自动创建：The default value is value. default 0xCCCCCC example exampleText 在指定位置的头部添加可自定义样式属性的代码实例 代码需要写在标签内 不规范样式时，实例代码会被先是在一个灰色可滚动的边框中example The following code sets the volume level for your sound: var mySound:Sound = new Sound(); mySound.setVolume(VOL_HIGH); exampleText string 在ASDoc命令中使用该标签 会将example标签中的内容放在一个附加文件中. 该命令必须写在实例代码前或之后附加实例文件支持在实例代码前后添加注释/* * This text does not appear * in the output. * exampleText But this does. */ inheritDoc用该标签解释重写的方法或属性. 可以从父类或父接口中把注释拷贝到子类中param和return标签 注释内容能被拷贝，其它标签不可以。也可以在inheritDoc标签之前添加注释.使用该标签后ASdoc会有一下:inheritDoc internal text 在输出的文档中会被隐藏的内容内容.但在类文件源代码中可以看到internal Please do not publicize the undocumented use of the third parameter in this method. 标签描述ArrayElementType在数组中定义所有允许的数据类型。Bindable声明一个属性可以在代码中使用数据绑定表达式。DefaultProperty定义组件在MXML中使用时的默认属性的名称。Deprecated标识一个类或类的元素是不推荐使用的，这样编译器能认出他并在被调用时给出一个警告信息。Effect定义MXML的特效属性名称。Embed在编译时导入 JPED,PNG,SVG 或 SWF文件。也会导入SWC文件的图片资源。他的功能等同于MXML中的 Embe 语法。Event定义MXML的事件属性的名称和类型。Exclude使 Flex Builder 的标签检查器忽略类元素。语法类似 Exclude(name=”label”, kind=”property”)ExcludeClass是 Flex Builder 标签检查器忽略类。这相当于ASDoc中的 private 标签。IconFile定义一个图标文件，使组件在Adobe Flex Builder的插入面板中以该图标显示。Inspectable定义一个属性的列表，供组件使用者在 Flex Builder 的的属性提示和标签检查中使用。同时也定义了属性的可用值。InstanceType指定了 IDeferredInstance 中的，属性接受的数据类型。NonCommittingChangeEvent定义一个事件过渡触发器。RemoteClass把一个ActionScript对象映射到Java对象。Style为组件的样式属性定义一个MXML标签属性。Transient当一个 ActionScript 对象被映射到Java对象后，被该标签标识的属性，会从发送到服务端的数据中忽略掉。在 Flex 内要使用外部资源文件，通常使用 Embed 将外部档案嵌入也可以指定一个 Class 名称如文件上所示：Embed(source=logo.gif)Bindablepublic var imgCls:Class;这样做法只是将外部资源转成 Class无法继承或是改变它的行为当然也可以用复合的方式来达到类似的功能其实 Embed 是可以 Link 到一个自订的 Class就像在 Flash 内，一个 Symbol Link 到一个 Class 一样做法很简单，直接把 Embed 加在自订 Class 前面即可package import flash.display.MovieClip; Embed(source=assets/assets.swf, symbol=FlashSymbol1) public class SymbolClass1 extends MovieClip public function SymbolClass1():void roll(); public function roll():void this.x = Math.random() * 300; this.y =