coffeescript - CoffeeScript 上的 Javadoc?

标签 coffeescript

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

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

最佳答案

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

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

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

关于coffeescript - CoffeeScript 上的 Javadoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5850544/

相关文章:

CSS:如何根据屏幕尺寸调整圆形进度条(移动端)

javascript - 无法在 CoffeeScript 中声明命名函数

javascript - Accordion 面板不应在 if 条件下打开 - coffeescript

javascript - CoffeeScript 中 $(document).on 和 ($ document).on 的区别?

ruby-on-rails-3 - 渲染部分 Rails3.x + Coffeescript

javascript - 将函数引用传递给函数失败

Node.js 类问题,或者我做错了什么?

coffeescript - 为 CoffeeScript 类创建命名空间

javascript - 关于 Coffeescript/Javascript 条件结果的问题

javascript - Coffeescript 类扩展比 Backbone 扩展更膨胀