2014-02-19 33 views
0

我用haxe编写了我的html5游戏api,现在我想从代码中的注释中自动生成文档。但是,我不知道该如何开始。我想尝试使用haxedoc,但我唯一的文档是这个网站上,它是不是非常有帮助,在所有:http://haxe.org/doc/haxedoc使用Haxedoc为我的项目生成文档

当我运行此命令:haXe的-xml的Output.xml build.hxml

它说build.hxml不存在。

如何让haxedoc浏览我的项目并生成文档? 特别感谢您的具体步骤。

回答

1

您可以创建一个用于文档的.hxml。如何创建.hxml记录在此处http://haxe.org/doc/compiler#example

+0

您是否必须创建一个hxml文件?我拥有的文件数量非常繁琐。 – user1261710

+0

hxml文件仅包含如何构建项目的说明,这是文档所需的。所以是的,我认为这是必要的。 –

+0

嗯,事情是我只想记录框架而不是游戏,所以游戏本身有一个构建文件,但不是框架。我从来没有单独构建框架,所以我觉得这种奇怪。该框架本身并不运行,所以我仍然需要创建该文件。 – user1261710