ActionScript的API文档生成工具ASDoc

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

最新评论