爲合金項目生成文檔

Question

對於ExtJS和香草javascript，jsduck非常棒。通過Appcelerator的github回購，他們已經修改jsduck來處理Titanium項目，但新的Alloy MVC框架又如何呢？

有沒有一種方法可以讓我還沒有看到爲Alloy代碼生成文檔？

謝謝

Answer 1

是的，我們也使用JSDuck合金。如果檢查出鈦3.0預覽文檔，你會看到兩種合金及鈦合金的API文檔部分：

http://docs.appcelerator.com/titanium/3.0/

的過程是這樣的：鈦，我們以我們現有的DOC格式（TDoc ，它基於YAML和Markdown），並將其轉化爲我們對JSDuck評論稍作修改的風格。

由於Alloy是用JavaScript編寫的，我們在源代碼中使用JSDuck註釋。當我們構建文檔時，我們通過JSDuck運行合金源和生成的鈦註釋。

JSDuck很適合這個，但我應該注意到我們不是真正利用了JSDuck從代碼中推斷信息的能力。在我有限的測試中，Alloy代碼並不如此。

doctools回購包含我們用於構建文檔的配置文件&。如果你想看看我們如何產生這個文檔的網絡設置，請參閱：

https://github.com/appcelerator/doctools/blob/master/deploy.sh

還有就是如何建立構建環境中的自述文件doctools回購的基本概述：

https://github.com/appcelerator/doctools

恐怕現在有很多依賴和文檔構建腳本不是非常用戶友好。但是，如果遇到任何問題，請告訴我。