为合金项目生成文档

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

恐怕现在有很多依赖和文档构建脚本不是非常用户友好。但是，如果遇到任何问题，请告诉我。