ThinkChat2.0新版上线,更智能更精彩,支持会话、画图、阅读、搜索等,送10W Token,即刻开启你的AI之旅 广告
当执行 haxedoc 来创建一个目录,包含许多 HTML 文件 - 每个类型的定义都会生成要给,一个子目录对应一个包,一个 index.html 文件会包含一个链接到所有生成的文档的列表。注意,文档会包含关于每个在应用中导入类型的信息,和那些标准库或者 haxelib 中类型的信息。 haxedoc 命令接受下面的语法: ~~~ haxedoc file.xml;platform -f ClassName ~~~ Haxe 编译器生成 file.xml 文件的地方,platform 是一个指示,这个文件是针对哪个特定平台(多平台可用), -f (filter) 用来生成某个特地哦那个类型(这个开关可以重复多次)的文档。 file.xml 和 -f 开关都可以出线多次,而使用不同的值。在第一种情况,不同平台的文档会被合并在一个单独的结构以避免重复信息;重复过滤器开关使你可以生成多个文件的文档。 在包含 doc.xml 的目录执行下面的命令生成一组 HTML 文件,可以使用浏览器进行查看。 ~~~ haxedoc doc.xml;neko ~~~ 如果生成的 index.html 页面在浏览器中打开,一个链接列表会被呈现出来。虽然可能不太美观,因为没有在生成文档时使用模板。要创建更好看的文档,拷贝 Haxe 安装目录下 std/tools/haxedoc 目录中的文件 template.xml 到 XML 文件相同目录即可。这个模板和 API 文档中使用的是相同的。否则,可以使用这个模板作为一个参考,并修改它符合项目的需求。