使用 Haxedoc 为我的项目生成文档

【问题标题】：Using Haxedoc to generate documentation for my project使用 Haxedoc 为我的项目生成文档
【发布时间】：2014-02-19 22:58:06
【问题描述】：

我用 haxe 编写了我的 html5 游戏 api，现在我想从代码中的 cmets 自动生成文档。但是，我什至不知道如何开始。我想尝试使用 haxedoc，但我唯一的文档是在这个网站上，它根本不是很有帮助：http://haxe.org/doc/haxedoc

当我运行这个命令时：haxe -xml output.xml build.hxml

它说 build.hxml 不存在。

如何让 haxedoc 完成我的项目并生成文档？非常感谢具体步骤。

【问题讨论】：

【解决方案1】：

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

【讨论】：

一定要制作hxml文件吗？我拥有的文件数量非常繁琐。
hxml 文件仅包含如何构建项目的说明，这是文档所必需的。所以是的，我认为这是必要的。
好吧，我只想记录框架而不是游戏，所以游戏本身有一个构建文件，但没有框架。我从不单独构建框架，所以我觉得这种奇怪。框架根本不自己运行，所以我仍然需要制作这个文件。
嗯，我认为这确实有道理，你想要框架的文档，然后你需要完全构建框架。否则，您也会在其中获得与项目相关的类。它是一个什么样的目标？我可以为你创建一个简单的 hxml，可能是 4 行指令。