Flex帮助文档(html格式)制作及ASDoc的使用

所属分类: 网络编程 / Flex 阅读数: 412
收藏 0 赞 0 分享

最近工作上需要把这几个月研发的Flex Realspace产品在sp3时上线,急需制作帮助文档,之前开发的时候注释都是按着习惯性卸载代码里面的,也没有考虑后期的帮助文档,这几天愁啊,公司其他Flex产品用的是自己写的带包工具,我可没那么多时间,查了很多资料,希望通过ASDoc达成愿望。

ASDoc是adobe官方提供的ActionScript的API文档生成工具,早已经集成在Flex Builder中,我使用的是Flex Builder4.6,使用方法如下;

1、首先配置一个生成文档需要的环境,按照下面步骤

运行->外部工具->外部工具配置

点击“新建启动配置”,生成如下界面,填上如下信息:

名称:随意,这里我取的ASDoc。
位置:选择你安装目录下asDoc.exe所在的路径,我的是D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\bin\asdoc.exe
工作目录:直接默认为${project_loc},这样系统会从你当前打开的as类或mxml文件所在的项目作为默认输出项目
自变量:这方面的参数网上资料很多,我这里不详细说明
-source-path:代码所在的目录(不能用中文目录)
-doc-sources:文件所在的目录(不能用中文目录)
-output: 输出文档的目录(不能用中文目录)
-external-library-path:扩展的Lib路径(外部的swc的路径)(不能用中文目录)
-main-title 文档首页显示的标题,这里我添加为 "SuperMap iClient 6R(2012) for Flex Realspace 帮助文档"
这里我写了如下三个,前两个必须写。
-source-path src
-doc-sources src
-main-title "SuperMap iClient 6R(2012) for Flex Realspace 帮助文档"

2、文档支持中文注释

为了让生成的文档支持中文注释,我们需要切换到“公共”,编码->其他->选择UTF-8。如下:

3、运行

点击“应用”进行保存,我们可以直接点击下面的运行,同时,在点击应用的时候会在外部工具里面能生成一个快捷键,以后就很方便了,并且还可以再次修改。

最后控制台出现如上信息表示生成成功,如果出现红色字体,表示有错误,最常见的错误

[Fatal Error] toplevel.xml:25186:244: The value of attribute "defaultValue" must not contain the '<' character.

Error: Could not create toplevel.xml: The value of attribute "defaultValue" must not contain the '<' character.

是因为你的注释某些地方有问题,比如标签有没有闭合,是不是用了一些特殊字符,比如><@、<b>等等。 SDK4.x本身没有错误,只是容错性比较差,出错提示也很烂,但是只要按规则写,就可以通过。

成功后的文件如下的红圈文件内部:

点击此文件里面的index.html可以查看生成的界面如下:

细心的读者可能会发现自己生成的是全英文的,而我的是汉化版的,并且一些图标都改了,找到你自己的flash builder的安装目录,在D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\asdoc下有一个文件夹叫templates,其实我们打包就是靠的这个文件夹里面的东西,我们公司自己做了一些修改,然后把这个文件替换了,就可以汉化了,并且支持了自己公司的图标,有想要的可以留言,写上自己的邮箱。

更多精彩内容其他人还在看

flex tomcat端口被占用的问题分析及解决方法

在启动Tomcat,提示8080端口被占用了,该如何解决呢?本文整理了一些修改方法,感兴趣的朋友可以参考下,希望可以帮助到你
收藏 0 赞 0 分享

flash 报错捕获(Catch All Exception in Flash)

就是在全局任何地方产生的错误如果没有被捕获,都可以在捕获阶段和冒泡阶段被捕获,接下来为大家介绍一种可以捕捉所有错误的方法,感兴趣的你可不要错过了哈
收藏 0 赞 0 分享

flex 开发项目报错之404错误解决方案

最近两天被HttpStates404这个错误折腾的够呛,查了很多的文章都是大同小异,接下来为大家介绍下详细的解决方法,感兴趣的各位可以参考下哈,希望可以帮助到你
收藏 0 赞 0 分享

Flex动态生成可编辑的DataGrid具体实现代码

DataGrid具有以下功能:表头是动态生成的、每行都是有序号的、每行都是可以编辑、插入、删除、修改,接下来为大家分享下Flex如何动态生成可编辑的DataGrid
收藏 0 赞 0 分享

flex打印操作(FlexPrintJob)还有分页打印操作具体实现

如果要使用分页效果,则必须使用标签"PrintAdvancedDataGrid"(Flex3中的标签)才能够实现分页效果,感兴趣的朋友可以参考下
收藏 0 赞 0 分享

flex中event.preventDefault()方法取消事件的默认行为

当点击datagrid的第一和第四项时,itemEdit事件将不起作用,许多事件都有默认执行的关联行为,接下来为大家详细介绍下,感兴趣的朋友可以参考下哈
收藏 0 赞 0 分享

flex4.5中CSS选择器的应用小结

与HTML相似,Flex允许在MXML标签中通过CSS样式来设置组件的外观。到flex4.5后已经基本上支持了HTML中的所有CSS的应用方式,这里主要来列举下flex4.5中CSS选择器的使用方法
收藏 0 赞 0 分享

Flex Label控件竖排显示文字的实现代码

Label控件竖排显示文字一般都是横排的,接下来为大家分享个方法让它变成竖排,感兴趣的童鞋们可以学习下,希望对你有所帮助
收藏 0 赞 0 分享

flex4 panel去掉标题设置透明度效果代码

首先:去掉Panel的标题,其次:设置透明度这个说了也是啰嗦,大家都会,不过还是提一下吧,具体请祥看本文
收藏 0 赞 0 分享

Flex自定义右键菜单具体实现

自定义右键菜单在flex的实现想必有很多朋友都没有尝试过吧,下面与大家分享下如何实现,具体代码如下
收藏 0 赞 0 分享
查看更多