ASDoc是Adobe自带的文档生成工具。可以生成类似JavaDoc格式的文档。
关于ASDoc详情参见官方文档:
http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7fe7.html。
要想使用ASDoc工具来生成项目API文档,
可以使用命令行
,也可以在FlashBuilder中来添加外部工具及配置相应的参数来完成。
本文介绍第二种方式。实质上第二种方式和第一种方式执行的原理是一样的,只是第二种方式配置界面化了,方便我们执行。
1、打开Flash Builder后,Run -> External Tools -> External Tools Configurations..,如图:
2、在弹出的界面中,选中Program,点击添加图标添加外部程序。
3、在弹出的外部程序信息配置中,添加相应的信息。
Location:ASDoc.exe所在的路径。该程序在Flash Builder安装目录
../Adobe Flash Builder 4.6/sdks/4.6.0/bin/asdoc.exe。
Working Directory:可以浏览工作区的目录,也可以选择文件系统的目录或者使用变量。
Arguments:ASDoc生成文档的参数。以下选择Working Directory目录下的src作为源目录,输出到
Working Directory目录下的doc目录
-source-path src
-doc-sources src
-output doc
-main-title "D5 Power API doc"
4、支持中文注释
选择Common选项卡,在Encoding中选择Other,然后选择UTF-8。如图:
操作完之后,点击Apply按钮,然后点击 Run按钮,生成项目的文档。
常见错误
1. Error: could not find JRE
解决办法:
找到文件Adobe Flash Builder 4.5\sdks\4.5.0\bin\jvm.config
然后键入你的JRE的安装目录,作为java.home的变量,假设你的java安装你的根目录下的话,那么键入:
java.home=C:/Program Files/Adobe/Adobe Flash Builder 4.5/jre //注意文件分隔符 是'/',即反斜杠
注意:是JRE文件夹目录,而不是JDK目录。确保其中的jre文件夹下的bin目录中要有java.dll文件。
2. FlashBuilder 使用ASdoc乱码问题
解决办法:
找到文件Adobe Flash Builder 4.5\sdks\4.5.0\bin\jvm.config,在java.args=那行后面修改为:
java.args=-Xmx384m -Dsun.io.useCanonCaches=false -Dfile.encoding=utf-8 -Dsun.jnu.encoding=utf-8
3. 元素的内容必须由格式正确的字符数据或标记组成。
解决办法:
其他问题参见网络吧
http://bbs.9ria.com/thread-116151-1-1.html
http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bc36-7ffa.html
http://help.adobe.com/zh_CN/flex/using/WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7fed.html#WSd0ded3821e0d52fe1e63e3d11c2f44bb7b-7ff6