源码网,源码论坛,源码之家,商业源码,游戏源码下载,discuz插件,棋牌源码下载,精品源码论坛

 找回密码
 立即注册
查看: 718|回复: 19

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

[复制链接]

7万

主题

861

回帖

32万

积分

论坛元老

Rank: 8Rank: 8

积分
329525
发表于 2013-2-1 14:32:22 | 显示全部楼层 |阅读模式
Flex Realspace产品在sp3时上线,急需制作帮助文档,由于在开发的时候没有考虑后期的帮助文档,查了很多资料,希望通过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 '
Error: Could not create toplevel.xml: The value of attribute "defaultValue" must not contain the '
是因为你的注释某些地方有问题,比如标签有没有闭合,是不是用了一些特殊字符,比如>
成功后的文件如下的红圈文件内部:

点击此文件里面的index.html可以查看生成的界面如下:

细心的读者可能会发现自己生成的是全英文的,而我的是汉化版的,并且一些图标都改了,找到你自己的flash builder的安装目录,在D:\Adobe Flash Builder 4.6\Adobe Flash Builder 4.6\sdks\4.6.0\asdoc下有一个文件夹叫templates,其实我们打包就是靠的这个文件夹里面的东西,我们公司自己做了一些修改,然后把这个文件替换了,就可以汉化了,并且支持了自己公司的图标,有想要的可以留言,写上自己的邮箱。
回复

使用道具 举报

0

主题

1万

回帖

0

积分

中级会员

Rank: 3Rank: 3

积分
0
发表于 2022-11-3 11:07:07 | 显示全部楼层
源码源码源码源码源码源码源码源码源码源码源码源码源码
回复 支持 反对

使用道具 举报

2

主题

1万

回帖

146

积分

注册会员

Rank: 2

积分
146
发表于 2022-12-11 06:02:35 | 显示全部楼层
灌灌灌灌水
回复 支持 反对

使用道具 举报

1

主题

2万

回帖

182

积分

注册会员

Rank: 2

积分
182
发表于 2023-1-22 21:51:31 | 显示全部楼层
而非为吾问无为谓娃娃
回复 支持 反对

使用道具 举报

1

主题

1386

回帖

1509

积分

金牌会员

Rank: 6Rank: 6

积分
1509
发表于 2023-5-22 04:56:52 | 显示全部楼层
还有什么好东西没
回复 支持 反对

使用道具 举报

0

主题

1万

回帖

0

积分

中级会员

Rank: 3Rank: 3

积分
0
发表于 2023-8-20 20:06:50 | 显示全部楼层
啊啊啊啊啊啊啊啊啊啊啊啊啊啊
回复 支持 反对

使用道具 举报

0

主题

1万

回帖

0

积分

中级会员

Rank: 3Rank: 3

积分
0
发表于 2024-3-12 04:00:49 | 显示全部楼层
啦啦啦啦啦德玛西亚
回复 支持 反对

使用道具 举报

29

主题

2万

回帖

194

积分

注册会员

Rank: 2

积分
194
发表于 2024-3-19 04:44:55 | 显示全部楼层
的沙发水电费水电费
回复 支持 反对

使用道具 举报

16

主题

2万

回帖

376

积分

中级会员

Rank: 3Rank: 3

积分
376
发表于 2024-4-1 13:49:32 | 显示全部楼层
天天源码社区论坛
回复 支持 反对

使用道具 举报

1

主题

2万

回帖

307

积分

中级会员

Rank: 3Rank: 3

积分
307
发表于 2024-5-24 19:25:49 | 显示全部楼层
66666666666
回复 支持 反对

使用道具 举报

高级模式
B Color Image Link Quote Code Smilies

本版积分规则

手机版|小黑屋|网站地图|源码论坛 ( 海外版 )

GMT+8, 2024-11-22 14:28 , Processed in 0.091570 second(s), 26 queries .

Powered by Discuz! X3.4

Copyright © 2001-2020, Tencent Cloud.

快速回复 返回顶部 返回列表