coffeescript - CoffeeScript 上的 Javadoc？

Question

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

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

score 22 · Accepted Answer

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

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

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

score 15 · Accepted Answer

15

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

于 2011-12-01T14:34:21.763 回答

score 7 · Accepted Answer

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

score 0 · Accepted Answer

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

检查此文档示例：http: //yui.github.com/yuidoc/api/

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

npm install yuidocjs -g

4 回答 4