近期工作方面必须把这几个月产品研发的Flex Realspace商品在sp3时发布,急缺制做帮助文档,以前开发设计的情况下注解全是按照下意识卸载掉编码里边的,都没有考虑到中后期的帮助文档,近几天愁啊,企业别的Flex商品用的是自身写的带包专用工具,我可没那么多時间,查了许多材料,期待根据ASDoc达到心愿。

ASDoc是adobe官方网出示的ActionScript的API文本文档生成专用工具,早早已集成化在Flex Builder中,我应用的是Flex Builder4.6,操作方法以下;

1、最先配备一个生成文本文档必须的自然环境,依照下边流程

运作->外界专用工具->外界专用工具配备

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

点一下“在建起动配备”,生成以下页面,填入以下信息内容:

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

名字:随便,这儿我取的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 帮助文档"
这儿我写了以下三个,前2个务必写。
-source-path src
-doc-sources src
-main-title "SuperMap iClient 6R(2012) for Flex Realspace 帮助文档"

2、文本文档适用汉语注解

为了更好地让生成的文本文档适用汉语注解,大家必须转换到“公共性”,编号->别的->挑选UTF-8。以下:

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

3、运作

点一下“运用”开展储存,我们可以立即点一下下边的运作,另外,在点一下运用的情况下会在外界专用工具里边能生成一个键盘快捷键,之后就很便捷了,而且还能够再度改动。

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

最终控制面板出現如上信息内容表明生成取得成功,假如出現红色字体,表明有不正确,最普遍的不正确

[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的使用 ASDoc html Flex帮助文档 Flex  第5张

点一下此文档里边的index.html能够 查询生成的页面以下:

Flex帮助文档(html格式)制作及ASDoc的使用 ASDoc html Flex帮助文档 Flex  第6张 仔细的阅读者很有可能会察觉自己生成的是全英的,可是我的是简体中文版的,而且一些标志都改了,找到你自身的flash builder的安装文件,在D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\asdoc下有一个文件夹名称叫templates,实际上大家装包便是靠的这一文件夹名称里边的物品,大家企业自己做了一些改动,随后把这个文档更换了,就可以简体中文版了,而且适用了自身企业的标志,有要想的能够 留言板留言,写上自身的电子邮箱。