• linkedu视频
  • 平面设计
  • 电脑入门
  • 操作系统
  • 办公应用
  • 电脑硬件
  • 动画设计
  • 3D设计
  • 网页设计
  • CAD设计
  • 影音处理
  • 数据库
  • 程序设计
  • 认证考试
  • 信息管理
  • 信息安全
菜单
linkedu.com
  • 网页制作
  • 数据库
  • 程序设计
  • 操作系统
  • CMS教程
  • 游戏攻略
  • 脚本语言
  • 平面设计
  • 软件教程
  • 网络安全
  • 电脑知识
  • 服务器
  • 视频教程
  • JavaScript
  • ASP.NET
  • PHP
  • 正则表达式
  • AJAX
  • JSP
  • ASP
  • Flex
  • XML
  • 编程技巧
  • Android
  • swift
  • C#教程
  • vb
  • vb.net
  • C语言
  • Java
  • Delphi
  • 易语言
  • vc/mfc
  • 嵌入式开发
  • 游戏开发
  • ios
  • 编程问答
  • 汇编语言
  • 微信小程序
  • 数据结构
  • OpenGL
  • 架构设计
  • qt
  • 微信公众号
您的位置:首页 > 程序设计 >Flex > Flex帮助文档(html格式)制作及ASDoc的使用

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

作者: 字体:[增加 减小] 来源:互联网 时间:2017-05-11

通过本文主要向大家介绍了Flex帮助文档(html格式)制作及ASDoc的使用等相关知识,希望对您有所帮助,也希望大家支持linkedu.com www.linkedu.com

最近工作上需要把这几个月研发的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,其实我们打包就是靠的这个文件夹里面的东西,我们公司自己做了一些修改,然后把这个文件替换了,就可以汉化了,并且支持了自己公司的图标,有想要的可以留言,写上自己的邮箱。

</div>
分享到:QQ空间新浪微博腾讯微博微信百度贴吧QQ好友复制网址打印

您可能想查找下面的文章:

相关文章

  • 2017-05-11Flex父子窗口相互调用实现思路及源码
  • 2017-05-11Flex tree加虚线显示效果并且替代原始图标
  • 2017-05-11Flex 改变树结点图标的2种方法介绍
  • 2017-05-11flex利用webservice上传照片实现代码
  • 2017-05-11在as中监听自定义事件并处理事件的实例代码
  • 2017-05-11flex渐变色制作圆角橙色按钮示例代码
  • 2017-05-11Flex设置LinkButton的背景色有思路有源码
  • 2017-05-11FLEX HashMap遍历并取到需要的值
  • 2017-05-11flex中event.preventDefault()方法取消事件的默认行为
  • 2017-05-11Flex中怎么给表格中的滚动条定位避免刷新回到原处

文章分类

  • JavaScript
  • ASP.NET
  • PHP
  • 正则表达式
  • AJAX
  • JSP
  • ASP
  • Flex
  • XML
  • 编程技巧
  • Android
  • swift
  • C#教程
  • vb
  • vb.net
  • C语言
  • Java
  • Delphi
  • 易语言
  • vc/mfc
  • 嵌入式开发
  • 游戏开发
  • ios
  • 编程问答
  • 汇编语言
  • 微信小程序
  • 数据结构
  • OpenGL
  • 架构设计
  • qt
  • 微信公众号

最近更新的内容

    • Flex 事件分发(FlexViewer事件机制)剥离过程
    • Flex 关于字体的应用示例介绍
    • Flex 输出文件到本地的两种方法
    • flex复选框和下拉列表的几种用法整理
    • Flex中对表格中某列的值进行数字格式化保留两位小数
    • Flex中通过RadioButton进行切换示例代码
    • FLEX HashMap遍历并取到需要的值
    • flex中如何用图像给按钮做皮肤
    • Flex实现双轴组合图的设计思路及代码
    • Flex帮助文档(chm格式)制作及FAR的使用

关于我们 - 联系我们 - 免责声明 - 网站地图

©2020-2025 All Rights Reserved. linkedu.com 版权所有