CoffeeScript 上的 Javadoc？答案

【问题标题】：Javadoc on CoffeeScript?CoffeeScript 上的 Javadoc？
【发布时间】：2012-11-26 14:19:39
【问题描述】：

我是 CoffeeScript 新手，似乎找不到任何使用 Javadoc 语法的 CoffeeScript 文档生成器。我能找到的唯一一个可以作为 CoffeeScript 编译器的补丁。

那么，您使用什么来从 CoffeeScript 上的 Javadoc 注释生成文档，或者您如何记录您的函数参数和返回值？

【问题讨论】：

【解决方案1】：

因此，JavaDoc 语法从未真正受到 JavaScript 开发人员的欢迎。有些人使用类似的东西——尤其是谷歌——但它与 JS 有点矛盾，JS 没有静态类型并且允许任何函数的任意数量的参数。

如果你想用 CoffeeScript 创建漂亮的文档，标准是Docco（它的主页就是一个很好的例子）。如果您想为每个函数创建 JavaDoc 样式的 cmets……那么，您必须手动创建它们，并用反引号将它们转义。

或者，您可以在 CoffeeScript 中工作，直到您的代码准备好发布，然后记录生成的 JavaScript。

【讨论】：

还有 JSDoc，如果你想要更多类似 JavaDoc 的东西。但 Docco 很棒。
注意docco不支持多行cmets、递归源目录、指定输出目录。噗！
@alexandru.topliceanu 据我了解，docco 是一种概念验证，它比预期更受欢迎。您总是可以贡献一两个补丁来添加这些功能。（如果我能找到时间，我可能会贡献一个合适的命令行选项解析器，这样--help 之类的东西就可以工作了）
Docco 没有解决同样的问题。带注释的（有时称为“literate”）代码和 API 文档之间存在很大差异。

【解决方案2】：

Docco 非常适合程序化编码风格。如果您想记录 API，coffeedoc 适合您。

【讨论】：

【解决方案3】：

希望在 coffeescript 中使用 javadoc 样式文档的人可以查看 codo (http://netzpirat.github.com/codo/)，它提供了对 javadoc 子集的支持，并自动从源代码中推断出类名、函数名和参数。

【讨论】：

【解决方案4】：

我正在使用YUIDoc。我可以使用类似于 Javadoc 的语法将 cmets 添加到我的类、方法和事件中。文档以 html/css 文件的形式输出，您甚至可以自定义页面布局。

PS：依赖Node.JS，需要安装包yuidocjs

npm install yuidocjs -g

【讨论】：