使用ASDoc标签生成ActionScript3.0 API文档

12年前

    常用FLASH ASDoc 文档注释标签

@param paramName description
     描述方法或构造函数的单个参数。
     paramName:参数名。
     description:参数说明。

@return description
     描述方法的返回值。
     description:返回值的说明。

@throws package.class.className description
     声明一个可能被抛出的错误。
     package.class.className:错误的类型名称。
     description:对引发错误的说明。

@default value
     指定属性、式样、或效果的默认值。
     value:默认值。

@eventType package.class.CONSTANT
     描述事件的类型,即事件对象的 type 属性值。
     package.class.CONSTANT:一般为事件类的公共常量,定义事件对象的 type 属性值;也可以是表示事件类型的字符串。
 
@see reference [displayText]
     添加一个“另请参见”项,并创建到某一成员的链接。
     reference:成员的 API 名称。具体形式如下:
     ?@see http://www.examples.com
     ?@see MyClass
     ?@see package.MyClass
     ?@see MyClass#name
     ?@see #method()
     ?@see MyClass#method()

    displayText:可选,该链接的显示文字。
 
@example exampleText
     提供类型或某一成员的使用示例。
     exampleText:示例的文本内容,通常包含 <listing version="3.0"></listing> 标记,该标记的内容被识别为程序代码。
 
@deprecated
     标记该 API 已过时。

      除了使用adobe的ASDoc工具以外,还可以使用DocsBuilder分析包含这些文档标签的AS2/AS3类文件源码,生成API文档。
 
     DocsBuilder还可以通过自定义模板文件,生成任何想要的文档内容。

    下载地址:http://原网站已经失效/DocsBuilder/DocsBuilderGUI.zip

     DocsBuilder主页:http://原网站已经失效/DocsBuilder.xhtml