adobe官方提供的ActionScript的API文档生成工具，集成在FlexBuilder3之中,今天静下心来试用了下,把步骤记录于此.
一:打开ASDoc工具

安装Flex3时,会在开始菜单的目录中生成一个快捷按钮

一般目录为:开始—>程序—>Adobe—>Adobe Flex 3 SDK Command Prompt

打开后,会进入cmd命令行界面

二:设置生成路径

使用cmd命令将目录指定到需要生成的文档中

使用cd指令改变当前位置

如:要进入E:/fwb

先执行E:进入E盘,再用cd fwb进入指定目录

三:生成文档

执行asdoc指令 asdoc -source-path . -doc-sources . 会输出所有AS的帮助文档了

注意,有两个点,都要空格后输入

 完成后,会在同一目录下生成一个asdoc-output文件夹,本例目录为 E:\fwb\asdoc-output

注意:生成的AS工程必须保证测试能通过才行,在编写AS时要保证各声明与备注完善才能生成一套比较适用的帮助

asdoc命令参数列表：

asdoc命令参数使用方法等同于mxmlc和compc
更多的mxmlc和comp信息，参见 Using the flex Compilers

参数功能列表如下：

Option  Description
-doc-classes path-element [...] 指定需要被输出成文档的类文件，这些类文件必须放在资源路径下[默认参数]
该参数使用方法等同于compc组件编译器的-include-classes参数，更多信息参见 Using compc, the component compiler
-doc-namespaces uri manifest  要求被输出成文档的类文件URIs列表，这些类文件必须放在资源路径下。
必须包含至少一个URI并指出命名空间内容的明确位置
该参数使用方法等同于compc组件编译器的-include-namespaces参数，更多信息参见Using compc, the component compiler
-doc-sources path-element [...] 需要被输出成文档的文件目录，并且其子目录也会被递归输出
该参数使用方法等同于compc组件编译器的-include-sources参数，更多信息参见Using compc, the component compiler
exclude-classes string 不需要被输出的类文件列表，必须指定类名
或者， 该类中的ASDoc命令里包含了 @private 标签，同样也不会被输出 ,多个类用-exclude-classes=com.class1,com.class2
-exclude-dependencies true|false        决定是否所有的相关类都会输出，如果设true，与输出类相关的类不会被输出。默认值为false
-footer string   文档中HTML页面底部的显示信息
-left-frameset-width int  控制文档左边目录宽度的整数值。你可以根据你的包名来改变这个值
默认值是210px
-main-title "string"  文档中HTML页面头部显示信息
默认值是"API Documentation".
-output string  输出文档的目录名. 默认值 "asdoc-output".
-package name "description"  输出文档中对应的包名。你可以指定一个以上的包
下例中，输出了两个包：
asdoc -doc-sources my_dir -output myDoc -package com.my.business "Contains business classes and interfaces" -package com.my.commands "Contains command base classes and interfaces"
-templates-path string ASDoc模板目录的路径. 默认值是ASDoc 安装目录下的asdoc/templates。该目录包含了用于输出成文档的所有的HTML, CSS, XSL文件image
-window-title "string" 文档中浏览器顶部显示信息
默认值是"API Documentation".

以下asdoc命令适用于compc组件编译器:

  • -source-path
  • -library-path
  • -namespace
  • -load-config
  • -actionscript-file-encoding
  • -help
  • -advanced
  • -benchmark
  • -strict
  • -warnings