Coffeescript 咖啡脚本上的Javadoc？

我不熟悉CoffeeScript，似乎找不到任何使用Javadoc语法的CoffeeScript文档生成器。我能找到的唯一一个是CoffeeScript编译器的补丁

---

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

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

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

---

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

Docco非常适合prozedural编码风格。如果您想记录一个API，它就是为您准备的。

希望在coffeescript中使用javadoc风格文档的人可以签出codo（），它提供对javadoc子集的支持，并从源代码自动推断类名、函数名和参数

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

检查此文档示例：

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

npm install yuidocjs -g

---

如果你想要更像JavaDoc的东西，还有JSDoc。但是Docco是惊人的。要知道Docco不支持多行注释、递归源目录和指定输出目录。Pfff@据我所知，docco是一种概念的证明，比预期的更受欢迎。您可以随时提供一两个补丁来添加这些功能。（如果我能找到时间，我可能会提供一个合适的命令行选项解析器，这样像

--help

这样的东西就不会解决同样的问题了）。annoted（有时称为“可读”）代码和API documentation之间有很大的区别。docco和coffeedoc是互补的，这非常好：）thx指出了这一点^^^^是的。这是迄今为止最自然的解决方案。