2014-02-19 34 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