Flex AsDoc 文档API生成工具 可以生成和Adobe的ActionScript3帮助一样的文档

 

ASDoc是adobe官方提供的ActionScript的API文档生成工具，现在已经集成在FlexBuilder3中；
使用ASDoc工具可以生成和Adobe的ActionScript3帮助一样的文档，使用的方法如下：

==========  本人操作成功的过程如下...火舞天涯http://blog.csdn.net/cjy37

Run ->  External Tools -> Open External Tools Dialog ....

1、New 一个项目，并命名！
2、主要是设置Main选项卡：
    1)、Location: 填asDoc.exe所在的路径 C:/Program Files/Adobe/Flex Builder 3/sdks/3.2.0/bin/asdoc.exe
    2)、Working Directory: 填工程中，代码所在的目录 ${workspace_loc:/HTFlexLib/src}
    3)、Arguments: 最重要的就是这里了，这里填的是AsDoc的编译参数 -source-path=. -doc-sources=${workspace_loc:/HTFlexLib/src}  -output="../../FlexDoc" -external-library-path="D:/work/flexWordFolders/flex3/libs/gearWheel.swc"
--------------------  参数说明  ----------------------
    -source-path：代码所在的目录（不能用中文目录）
    -doc-sources：文件所在的目录（不能用中文目录）
    -output：         输出文档的目录（不能用中文目录）
    -external-library-path：扩展的Lib路径（外部的swc的路径）（不能用中文目录）
3、为了AsDoc输出的文档支持中文的注释。
      切换到Common选项卡，Console Encoding分组项目 -> 选择Other -> 选择UTF-8

...火舞天涯  http://blog.csdn.net/cjy37===============

好，OK了，接着点Run～！ 文档就生成了，赶快去看看吧～！

 

参考的文章：http://www.flashas.net/html/FLASHfuzhuruanjian/20090106/3877.html

 

注：在MXML文件中如果有类似以下引用图标资源文件者，会报错：

  [Bindable] [Embed(source='assets/icon_alert.png')] private var alert_icon:Class;

解决的办法是创建一个资源类*.as类型的，专门保存一些图标等资源。如：

[Bindable] public class HtAssets { [Embed(source='assets/icon_alert.png')] public var alert_icon:Class; [Embed(source='assets/card.gif')] public var card_icon:Class; [Embed(source='assets/document.png')] public var document_icon:Class; public function HtAssets() { } static public function iconClass(s:String):Class { var tmpAssets:HtAssets=new HtAssets(); return tmpAssets[s]; } }

引用办法：

[Bindable] public var card_icon:Class=HtAssets.iconClass("card_icon");