egret-docs-master/Conversion/introduction/README.md

121 lines
5.5 KiB
Markdown
Raw Normal View History

2024-06-19 13:32:32 +08:00
本文档对EgretConversion工具做个大概介绍通过本文档可以总览工具的所有功能特征每个功能的具体用法在之后相应的文档中做详细解释。
## 一、菜单
**菜单->文件**
![](56b1abcd6d6dd.jpg)
新建转换项目这是EgretConversion的入口所有的转换项目都要从这里创建。点击将弹出”新建转换项目“面板填入项目名称、项目路径、项目类型、输出路径等几项参数。确定后将创建一个转换项目。
导入转换项目:导入一个之前已经创建好的转换项目。点击将弹出”导入项目“面板,选择或输入转换项目目录即可导入已存在的转换项目。
**菜单->帮助**
![](56b1abcdad74e.jpg)
欢迎界面:点击后标签页跳转到欢迎页
官网点击在浏览器中打开Egret官网页面。
文档中心点击在浏览器中打开EDN中心。
官方论坛:点击在浏览器中打开官方论坛。
使用手册点击在浏览器中打开EgretConversion文档页面。
提交bug点击弹出”问题反馈“面板可直接在这里提交遇到的bug或者给工具的开发团队提任何建议等反馈。并可上传附件。
关于EgretConversion点击打开关于面板主要用于查看当前EgretConversion版本号。
## 二、工具栏
![](56b1abcdd1b27.jpg)
1"新建转换项目"按钮,功能同菜单->文件->新建转换项目。
2"导入转换项目"按钮,功能同菜单->文件->导入转换项目。
3"转换"按钮点击将开始转换Flash的项目到Egret的项目转换过程在日志区中会有相关提示。详见后续文档。
4"编译"按钮点击将编译转换后的Egret项目编译过程在日志区有相关提示编译错误会直接显示在日志区。详见后续文档。
5"运行"按钮如果编译通过点击将直接运行egret的项目。详见后续文档。
6"停止运行"按钮如果转换后的项目正在运行点击可关闭egret内部服务器再刷新浏览器页面项目就无法运行了。参考运行项目。
7"SWF转换工具"按钮点击打开转换swf面板拖入swf文件即可单独转换为egret项目的资源。这部分在后面的文档中做详细解释。
8"问题反馈"按钮,功能同菜单->帮助->提交Bug。
## 三、项目工作区
![](56b1abcde7e59.jpg)
项目工作区位于界面左侧,这里列出了之前创建的转换项目。点选某个项目,在工具中所做的操作都是针对该项目。左键选择项目,右键可打开快捷菜单:
![](56b1abce13e7e.jpg)
删除:删除选中的转换项目。会弹出删除确定面板:
![](56b1abce322a2.jpg)
同时删除包含:删除项目的同时删掉转换项目目录下的所有文件。
不删除内容:只删除项目在工作区的引用,不真实删项目文件。
项目属性:点击打开项目的属性配置界面:
![](56b1abce99c22.jpg)
浏览输出目录:点击直接打开转换项目目录。
新建转换项目:功能同菜单->文件->新建转换项目。
导入转换项目:功能同菜单->文件->导入转换项目。
**标签页**
![](56b1abced2c08.jpg)
1转换步骤转换项目时的工作区详见下文。
2转换信息转换完项目后代码文件与swf文件的转换情况报告在这里全部列出。
3语法差异在as3代码转换到ts代码后typescript与actionscript不兼容语法都在这里列出可以对照提示逐条修改。详见后续文档的语法差异部分。
4API警告统计转换过程中遇到的API或者不可转换的as3类在这里列出详见后续文档如何手动修复此类警告信息。
5欢迎界面转换工具的欢迎页。有转换项目、导入项目等快捷方式示例项目相关教程链接等。
6登陆提供登陆和注册功能登陆后可以特定身份提交bug反馈给官方。
## 四、日志区
![](56b1abcf53c29.jpg)
日志区实时显示转换项目当前进度log信息提示信息等。
## 五、转换步骤标签页:
![](56b1abcf709b9.jpg)
转换Flash项目功能同工具栏->转换按钮
编译Egret项目功能同工具栏->编译按钮
运行Egret项目功能同工具栏->运行按钮
## 六、转换率评估区
![](56b1abcfbe8a8.jpg)
* 代码文件转换率as3文件到ts文件转换情况每个as3的文件都会被转换对应的ts文件语法从actionscript3转换为typescript的语法。这里显示了文件转换个数。点击条目会切换到”转换信息“页面在这里可看到具体的哪个文件转换成功了哪个转换失败了。
* API转换率统计了Flash的API转换到Egret过程中API成功转换的个数和比例此数值越高越好。点击条目会切换到“API警告统计”标签页。见“API警告统计”说明。
* 类型识别率统计了as3与ts在语法上类型转换一项上的个数统计与转换比例此数值越高越好。点击条目会切换到“语法差异”。见“语法差异”说明。
* swf文件转换率swf文件被解析的个数统计。点击条目会切换到”转换信息“页面在这里可看到具体的哪个文件转换成功了哪个转换失败了。
* 总体评价对上述几项数值做出的综合评估大体反应当前项目转换到egret的比例。此项数值越高越好但也不表明100%就表示完全转换成功不到100%就是转换失败,具体情况需视项目而论。