Flex AsDoc 文档API生成工具

本文介绍如何使用ASDoc工具生成Adobe ActionScript3的API文档,包括配置步骤、参数说明以及解决MXML文件引用图标资源的错误方法。通过新建项目并设置ASDoc的编译参数,生成与Adobe官方帮助文档类似的文档。此外,文章还提供了解决在MXML文件中引用图标资源时报错的方案,即创建资源类来专门保存图标等资源。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

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

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


英文配置:http://bhsc-happy.iteye.com/blog/320222


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.youkuaiyun.com/cjy37===============


好,OK了,接着点Run~! 文档就生成了,赶快去看看吧~!

 

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

 

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

 

·········10········20········30········40········50········60········70········80········90········100·······110·······120·······130·······140·······150
  1. [Bindable]   
  2. [Embed(source='assets/icon_alert.png')]  
  3. private var alert_icon:Class;  

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

·········10········20········30········40········50········60········70········80········90········100·······110·······120·······130·······140·······150
  1. [Bindable]  
  2. public class HtAssets  
  3. {  
  4.   [Embed(source='assets/icon_alert.png')]  
  5.   public var alert_icon:Class;  
  6.   
  7.   [Embed(source='assets/card.gif')]  
  8.   public var card_icon:Class;  
  9.   
  10.   [Embed(source='assets/document.png')]  
  11.   public var document_icon:Class;  
  12.       
  13.   public function HtAssets()  
  14.   {  
  15.   }  
  16.   
  17.   static public function iconClass(s:String):Class  
  18.   {  
  19.     var tmpAssets:HtAssets=new HtAssets();  
  20.       
  21.     return tmpAssets[s];  
  22.   }  
  23.   
  24. }  

引用办法:

·········10········20········30········40········50········60········70········80········90········100·······110·······120·······130·······140·······150
  1. [Bindable]   
  2. public var card_icon:Class=HtAssets.iconClass("card_icon");  

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值