关于CoffeeScript的Javadoc？

Question

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

那么,你用什么来生成来自CoffeeScript的Javadoc评论的文档,或者你如何记录你的函数参数和返回值？

Answer 1

因此,JavaDoc语法从未真正吸引JavaScript开发人员.有些人使用类似的东西 - 特别是谷歌 - 但它与JS有点不一致,JS没有静态类型,并允许任何函数的任意数量的参数.

如果你想用CoffeeScript创建漂亮的文档,标准是Docco(它的主页就是一个很好的例子).如果你想为每个函数创建JavaDoc风格的注释......那么,你必须手动创建它们,并用反引号转义它们.

或者,您可以使用CoffeeScript,直到您的代码准备好发布,然后记录生成的JavaScript.

Answer 2

Docco非常适合于编程风格.如果您想记录API,coffeedoc适合您.

Answer 3

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