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

在Flex Realspace产品即将上线sp3版本之际，急需一份详尽的帮助文档以辅助用户理解和使用这款产品。由于前期的开发过程中，我们主要专注于功能的实现，未对后期的文档制作给予足够的关注，导致现在需要紧急查找和整合相关资料来完善帮助文档。经过多方资料的查阅，我们决定采用ASDoc来达成目标。

ASDoc是Adobe官方提供的ActionScript的API文档生成工具，已经完美集成在Flex Builder中。在我使用的Flex Builder 4.6版本中，可以通过以下步骤来使用ASDoc：

一、配置文档生成环境

我们需要配置一个适合生成文档的环境。在Flex Builder中，运行外部工具配置，点击“新建启动配置”。然后设置相关参数，包括名称（可随意取）、路径（选择你安装目录下asDoc.exe所在路径）、工作目录（默认为当前打开的as类或mxml文件所在的项目）。还需要设置的参数包括-source-path、-doc-sources、-output等，这些参数网上有详细的说明，此处不再赘述。需要注意的是，所有路径应避免使用中文目录。

二、支持中文注释

为了让生成的文档支持中文注释，我们需要在公共编码设置中，选择UTF-8编码。

三、运行并生成文档

完成上述配置后，直接点击运行，系统会自动处理并生成文档。如果在运行过程中出现错误提示，如“defaultValue属性的值不能包含'<'字符”等，这通常是因为注释中存在标签未闭合或使用了特殊字符等问题。只要按照规则正确编写注释，就可以避免这类错误。

成功生成文档后，你会看到一个包含多个文件的文件夹。其中的index.html文件是文档的入口，打开后就可以看到我们生成的帮助文档界面。

细心的读者可能会发现，生成的文档是全英文的。而我们提供的版本是已经汉化过的，并且一些图标也进行了自定义。这是通过替换Flash Builder安装目录下的asdoc文件夹中的templates文件夹内的文件实现的。我们公司对此进行了一些修改，替换后就能实现汉化以及自定义图标的功能。如有需要，可以留言并提供自己的，我们会尽快将相关文件发送给您。

ASDoc是一个强大且实用的工具，能够帮助我们快速生成清晰、易懂的帮助文档。在Flex Realspace产品上线之际，通过ASDoc生成的帮助文档将为用户的使用提供极大的便利。