欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-06-10 13:56:08
最近工作上需要把这几个月研发的flex realspace产品在sp3时上线,急需制作帮助文档,之前开发的时候注释都是按着习惯性卸载代码里面的,也没有考虑后期的帮助文档,这...

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

asdoc是adobe官方提供的actionscript的api文档生成工具,早已经集成在flex builder中,我使用的是flex builder4.6,使用方法如下;

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

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

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

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

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

名称:随意,这里我取的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。如下:

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

3、运行

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

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

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

[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本身没有错误,只是容错性比较差,出错提示也很烂,但是只要按规则写,就可以通过。

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

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

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

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