制作弹性帮助文档(html格式)和使用ASDoc

在最近的工作中，有必要将最近几个月开发的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 \ as doc . exe:直接默认为${project_loc}。这样，系统会将您当前打开的as class或mxml文件所在的项目作为默认的输出项目自变量：关于这个参数有很多在线数据。这里就不细说了——来源——路径：代码所在目录(不允许中文目录)——文档——来源：文件所在目录(不允许中文目录)——输出：文档输出的目录(不允许中文目录)——外部——库——路径：扩展lib路径(外部swc的路径)(不允许中文目录)——主——标题文档首页显示的标题，这里我添加为‘SuperMap I Client 6R(2012)for Flex Real Space Help Document’。这里我写了以下三个标题，前两个必须写。-source-path src-doc-sources src-main-title ' SuperMap I Client 6R(2012)for Flex Real Space帮助文档' 2。该文档支持中文注释。为了使生成的文档支持中文标注，我们需要切换到“公共”，编码-其他-选择UTF-8。如下：。

3.单击“应用”保存操作。我们可以直接点击下面的“运行”。同时，点击“应用”时，可以在外部工具中生成一个快捷键，以后非常方便，可以再次修改。

最后，控制台上会出现上述信息，表明生成成功。如果出现红色字体，则表示有错误。最常见的错误[致命错误]是顶层。xml:25186:244:属性“默认值”的值不能包含“”字符。错误：无法创建顶级。xml33属性“默认值”的值不得包含“”字符。是因为你的标注存在一些问题，比如标签是否关闭，是否使用了一些特殊的字符，比如@，等等。SDK4.x本身没有错误，但是容错性差，错误提示很可怕，但是按照规则写就可以通过。成功的文件在红圈文件里面，如下所示：。

点击该文件中的index.html，查看生成的界面如下：。

细心的读者可能会发现，他们生成的都是英文版，而我的是中文版，有些图标已经改了。找到自己的flash builder安装目录，位于d : \ adobe flash builder 4.6 \ adobe flash builder 4.6 \ sdks \ 4 . 6 . 0 \ asdoc下有一个名为templates的文件夹。事实上，我们是按照这个文件夹的内容打包的。我们公司自己做了一些修改，然后替换了这个文件，可以本地化。它还支持我们公司的图标，如果我们需要可以留言，写在我们的邮箱里。