查看完整版本: [haxe 笔记]-haxe's工具使用

[haxe 笔记]-haxe's工具使用

[b]1.haxe[/b]
haxe目录下有五个可执行文件;
[b]haxesetup是安装注册程序;[/b]
[b]haxedoc是一个生成离线API文档的工具[/b]:
如果要生成在线API文档，使用haxedoc.n；
如果要制作自定义类的API文档，编译类的时候使用-xml output.xml生成API描述文件；
然后使用haxedoc制作API-html；
[b][i]生成haxeAPI的离线文档
[/i]语法:[/b]
haxedoc file.xml;platform [-f packagename -f classname]
例:
首先,通过std/all.hxml生成API描述文件XML.
然后执行以下命令生成API文档:
haxedoc flash.xml;flash neko.xml;neko js.xml;js
分号后跟一个名称，是用来指定xml里描述的API适用的平台,可选且可多选（多选时逗号分割）;
过滤:
只输出neko包内的API文档说明
haxedoc flash.xml;flash neko.xml;neko js.xml;js -f neko
[b][i]生成haxeAPI的在线文档
[/i][/b]将haxedoc.n拷到一个目录下.相对于这个目录建立存放API描述文档的文件夹(../data/media)
将flash.xml,neko.xml,js.xml拷贝到media目录.(API描述XML文档必须以他们适用的平台命名)
然后在haxedoc.n所在目录启动neko服务.
浏览器中浏览([url=http://localhost:2000/haxedoc.n]http://localhost:2000/haxedoc.n[/url]),之后会在服务根目录产生一个缓冲文件.data
API文档正常显示,但显示的API导航树链接是api/package/classname格式
需要服务端将其映射为haxedoc.n?package/classname格式
如:http://localhost:2000/haxedoc.n?class=flash9.display/Bitmap
[b]注:
[/b]以上两种方式生成的API文档并没有样式,可以利用template.xml增加样式;
离线版将其和API描述文档放置在一起,haxedoc生成html的时候自动套用模板样式.
在线版将其放置在neko服务根目录即可.
也可以参照它或在它基础上做一个自己定义的模板.
[b]haxeserver是一个快速启动neko服务的批处理文件:[/b]
(执行的是nekotools server);
在哪个目录启动的neko服务,http://localhost:2000,打开的就是哪个目录.
[b]haxelib可以下载,更新,删除,查看,(其它操作...)haxe第三方库:[/b]
已安装的haxelib存放在lib目录下;
例如:
安装haxelib-flex库:
haxe install flex  
查看已安装库列表:
haxelib list
更新所有已安装的库:
haxelib upgrade
...
等等。
[b]注:[/b]
所有工具的参数区分大小写,书写一定要注意,这里还要注意库名称;
大部分库下载后会自动解压放置在lib目录下,有些需要安装,运行命令:
haxelib run libname
如果在hx程序中使用了某个haxelib，那么在程序编译时使用:
-lib libname[:version]
version是可选的库版本
[b]haxe就是编译haxe程序的编译器了:
[/b]这是必不可少要用到的.
-help之后,看到它参数,多使用之后就容易掌握了;