Flex帮助文档(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\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，其实我们打包就是靠的这个文件夹里面的东西，我们公司自己做了一些修改，然后把这个文件替换了，就可以汉化了，并且支持了自己公司的图标，有想要的可以留言，写上自己的邮箱。

赞 (0)

相关推荐

  • simplehtmldom Doc api帮助文档

    API Reference Helper functions object str_get_html ( string $content ) Creates a DOM object from a string. object file_get_html ( string $filename ) Creates a DOM object from a file or a URL. DOM methods & properties stringplaintext Returns the conte

  • 最新的FlashCS3简体中文帮助文档chm提供下载了

    最新的FlashCS3简体中文帮助文档chm提供下载了

    关于本手册 本手册为在 ActionScript™ 3.0 中开发应用程序提供了基础.为了充分理解所介绍的理念和技巧,您应已熟悉了一般的编程概念,如数据类型.变量.循环和函数.您还应了解面向对象编程的基本概念,如类和继承.如果以前掌握了 ActionScript 1.0 或 ActionScript 2.0 知识,则会非常有帮助,但这并不是必需的. ActionScript 3.0 编程 ActionScript 快速入门 本章旨在让您可以着手进行 ActionScript 编程,同时为您提供了

  • 输入命令指令获取帮助文档的批处理

    例如当输入dir回车,则在目录下生成一个dir.txt的使用帮助.其实跟 dir /? >dir.txt一样的效果,不过通过批处理实现的更有意思. 复制代码 代码如下: @echo off :z @cls @set /p "d=输入要BAT指令:" @ %d% /? > %d%.txt goto z goto z

  • Flex帮助文档(chm格式)制作及FAR的使用

    Flex帮助文档(chm格式)制作及FAR的使用

    我在<Flex帮助文档制作(ASDoc--html篇)>中讲解了如何将自己的flex项目提取里面的注释生成网页形式的帮助文档,现在也比较流行这种方式,不过很多公司产品化的时候还需要提供chm格式的帮助文档,好像flex里面不能直接生成chm的文档,如果有读者会的话请联系我,我也学习一下,我这里主要讲解将生成的网页的文档转化为chm的格式.花了一天时间找了很多个软件,尝试了好久,很多软件并没有那么好用,我这里推荐FAR以及RoboHelp,不过RoboHelp破解版不好找,并且英文版的,我也不是

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

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

    最近工作上需要把这几个月研发的Flex Realspace产品在sp3时上线,急需制作帮助文档,之前开发的时候注释都是按着习惯性卸载代码里面的,也没有考虑后期的帮助文档,这几天愁啊,公司其他Flex产品用的是自己写的带包工具,我可没那么多时间,查了很多资料,希望通过ASDoc达成愿望. ASDoc是adobe官方提供的ActionScript的API文档生成工具,早已经集成在Flex Builder中,我使用的是Flex Builder4.6,使用方法如下: 1.首先配置一个生成文档需要的环境,

  • C#实现EXCEL数据到TXT文档的转换

    C#数据转换前excel中的数据格式如下:设备名称 规格型号 设备编号  使用部门 固定资产编号电脑1 IBM5660 10001 管理部 100010001电脑2 IBM5661 10002 研发部 100010002电脑3 IBM5662 10003 管理部 100010003C#数据转换到TXT文档的格式:"检测设备资产标签","设备名称","电脑1","规格型号","IBM5660","设

  • 得到XML文档大小的方法

    XML文档从格式到大小都是不是确定的.有的可能只有几行,而有的却有好几兆字节.你也许会怀疑是不是需要了解XML文档的大小.而当性能成为首要问题时,知道XML文档大小就是件必须要作的事情了. 从性能角度讲,有两类处理XML文档的方法.批量处理方式需要较短的时间,解析成组的文档.实时方式就是实时的处理文档.批处理方式的性能可以通过在一定时间内处理多少文档来测量,而实时模式的性能也采用类似的测量方式,不过是以处理一个文档需要多长时间来计算的. Scenarios场景 想象一下,你有一个实时工作的系统,

  • 如何得到XML文档大小

    XML文档从格式到大小都是不是确定的.有的可能只有几行,而有的却有好几兆字节.你也许会怀疑是不是需要了解XML文档的大小.而当性能成为首要问题时,知道XML文档大小就是件必须要作的事情了. 从性能角度讲,有两类处理XML文档的方法.批量处理方式需要较短的时间,解析成组的文档.实时方式就是实时的处理文档.批处理方式的性能可以通过在一定时间内处理多少文档来测量,而实时模式的性能也采用类似的测量方式,不过是以处理一个文档需要多长时间来计算的. Scenarios场景想象一下,你有一个实时工作的系统,比

  • 提供一个可以将DocX转为doc的文档转换器 地址

    提供一个可以将DocX转为doc的文档转换器 地址

    而DocX Convert为这兼容性问题提供了一个非常方便的解决方法,它可以把 .docx文档转换成文本格式,虽然有可能会丢弃原来的文档排版格式,但它至少可以保证在没有MS office 2007的情况下还可以读取里面的内容,以便急需之用.真是佩服老外的创造能力,连这个转换都做成了网站,再想想国内呢?成天都为流氓软件提心吊胆的.微软也是的,没事儿弄什么新的格式多了个x,07较之以外的版本有着很大的变化,估计还得适应一段时间才能上手,office07非常的智能,和vista一样对于资源占用也以往的

  • asp.net下用Aspose.Words for .NET动态生成word文档中的数据表格的方法

    asp.net下用Aspose.Words for .NET动态生成word文档中的数据表格的方法

    1.概述 最近项目中有一个这样的需求:导出word 文档,要求这个文档的格式不是固定的,用户可以随便的调整,导出内容中的数据表格列是动态的,例如要求导出姓名和性别,你就要导出这两列的数据,而且这个文档不是导出来之后再调整而是导出来后已经是调整过了的.看到这里,您也许马上想到用模板导出!而且.NET中自带有这个组件:Microsoft.Office.Interop.Word,暂且可以满足需求吧.但这个组件也是有局限性的,例如客户端必须装 office组件,而且编码复杂度高.最麻烦的需求是后面那个-

  • 从ASP.NET得到Microsoft Word文档的代码

    背景 自动化(Automation)是一个过程,它允许编程语言譬如Visual Basic.NET或C#写的应用程序可以编程控制其它应用程序.自动化到Word允许你执行像创建新文档,向文档中添加文本,邮件合并,还有控制文档格式这样的操作.使用Word和其它Microsoft Office应用程序,几乎所有你能在用户面板上手动实现的操作都可以通过自动化编程实现.Word通过一个对象模型来实现这个编程功能性(programmatically functionality).对象模型是一系列类和方法,它

  • 完美解决phpdoc导出文档中@package的warning及Error的错误

    今天在编写PHPDoc的导出文档的时候发现一个很郁闷的错误,虽然这个warning不是什么重要错误,但是看着总是很不爽的.于是就去网上找了很多相关的资料,可是郁闷的是不知道是我用的PHPDoc版本太新(1.4的版本),还是说很多人都没遇到这个问题,反正就是没有相关的这个资料找到,只是找到了一些从PHPDocumentor官方网倒出来的关于@package的使用注意事项,然后就只能一条一条检查,看了一个版本又一个版本,总算是被我解决了. 而且发现该方案可以解决@package之类相关的错误提示:

  • PHP中使用TCPDF生成PDF文档实例

    实际工作中,我们要使用PHP动态的创建PDF文档,目前有许多开源的PHP创建PDF的类库,今天我给大家来介绍一款优秀的PDF库,它就是TCPDF,TCPDF是一个用于快速生成PDF文件的PHP5函数包.TCPDF基于FPDF进行扩展和改进,增强了实用功能. 特性 TCPDF具有以下特性: 1.支持页面页脚: 2.支持HTML标签代码: 3.支持jpg/png/gif/svg图形图像: 4.支持表格: 5.支持中文字符:(有些PDF类不支持中文或者处理中文相当麻烦) 6.自动分页,自动页码,等等.

随机推荐