ActionScript的API文档生成工具ASDoc

　　运用ASDoc工具

　　原文地址: http://livedocs.adobe.com/flex/3/html/asdoc_9.html

　　译者注：

　　ASDoc是adobe官方提供的ActionScript的API文档生成工具，现在已经集成在FlexBuilder3中

　　打开ASDoc工具的方法：

　　1.安装FlexBuilder3后，

　　打开　　开始—>程序—>Adobe—>Adobe Flex 3 SDK Command Prompt

　　2.此时会进入cmd命令行界面，用cd命令进入你的工程目录下

　　例如我的工程目录是E:flexwork

　　当前是cmd指向在C:Program FilesAdobeFLexBuilder3

　　3.首先输入 E:进入E:

　　然后 输入 cd flexwork

　　屏幕显示E:flexwork>　后即可使用asdoc命令编译API文档了

　　编译后的asdoc文档会在E:flexwork路径下输出一个asdoc-output文件夹，运行里面的index.html就是API文档主页

　　你可以使用以下的ASDoc命令参数来制定类文件列表

　　doc-classes　　　 doc-sourcess　　　 doc-namespaces

　　doc-classes和doc-namespaces要求用source-path指定类文件文件所在的根目录

　　如下是一个最基本的列子，用doc-classes参数指定类文件列表：

　　asdoc –source-path . –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo

　　这个例子中，类文件必须是compsGraphingWidget.as和compsGraphingWidgetTwo.as,并且comps必须是位于运行asdoc命令所在位置下的一个子文件夹。doc-classes的参数中用‘.’对应类所在的包(package)名

　　译者注：如果类文件就在当前目录下，source-pathh参数后面的内容需要填写’.’

　　如果类文件没有在当前目录下，可以用source-path参数指定该目录。

　　下面的例子，如果两个类文件在C:flexclass_dircomps下，可以像这样使用asdoc命令：

　　asdoc –source-path C:flexclass_dircomps –doc-classes comps.CraphingWidget comps.GraphingWidgetTwo

　　如果你的程序里引用了包含有swc文件的库。

　　在下例中，可以使用 –library-path参数指定要包含的swc文件：

　　asdoc –source-path . –doc-classes myComponents.BlueButton –library-path C:myLibs

　　用 doc-sources参数可以指定源文件夹。通过该参数，asdoc会递归搜寻目录。

　　下面的命令会生成当前目录及其子目录下所有的类：

　　asdoc –source-path . –doc-sources

　　用 doc-namespaces参数可以指定要输出的命名空间。

　　下面的命令会把core framework下的所有类文件输出成文档：

　　asdoc -source-path frameworks -namespace http://framework frameworks/core-framework-manifest.xml -doc-namespaces http://framework

　　排除类文件

　　用doc-classes, doc-sources和 doc-namespaces命令输出所有的类文件时，

　　会有以下三点例外：

　　用exclude-classes参数指定的类不会输出

　　类中包含了@private标签的不会被输出

　　SWC中的类，不会被输出

　　以下的例子中，会输出当前目录及其子目录下所有类文件，除了compsPageWidget 和 compsScreenWidget.as：

　　asdoc -source-path . -doc-sources . -exclude-classes comps.PageWidget comps.ScreenWidget

　　注意：

　　这些被排除的类，仍然会同其他类一样被编译，只是内容不会被输出

　　如果将exclude-dependecies参数设为true，当编译类时所依赖的相关类不会被输出。

　　该参数默认值是false，意味着所有与指定类相关联的类都会被正常输出成文档。

　　例如：你用doc-classes指定了类A,如果类A中 import了类B，那么类A和类B都会被输出。

　　asdoc命令参数列表：

　　asdoc命令参数使用方法等同于mxmlc和compc

　　更多的mxmlc和comp信息，参见 Using the flex Compilers

　　参数功能列表如下：

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

　　-source-path

　　-library-path

　　-namespace

　　-load-config

　　-actionscript-file-encoding

　　-help

　　-advanced

　　-benchmark

　　-strict

　　-warnings

　　更多信息，参见 Using mxmlc, the application compiler还有很多其他程序编译参数可以使用，这里不再详加阐述，在ASDoc tool中你可以像使用mxmlc and compc一样使用同样的命令构造文件。