Flex帮助文档(html格式)制作及ASDoc的使用(flex插件是干什么的)速看

随心笔谈12个月前发布 admin
106 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帮助文档(chm格式)制作及FAR的使用输入命令指令获取帮助文档的批处理simplehtmldom Doc api帮助文档最新的FlashCS3简体中文帮助文档chm提供下载了

© 版权声明

相关文章