首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >CoffeeScript上的Javadoc?

CoffeeScript上的Javadoc?
EN

Stack Overflow用户
提问于 2011-05-02 02:50:25
回答 4查看 6.9K关注 0票数 16

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

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

EN

回答 4

Stack Overflow用户

回答已采纳

发布于 2011-05-02 03:50:31

因此,JavaScript开发人员从未真正流行过JavaDoc语法。有一些人使用类似的东西-特别是Google-但它与JS有些不同,JS没有静态类型,并且允许对任何函数使用任意数量的参数。

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

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

票数 22
EN

Stack Overflow用户

发布于 2011-12-01 22:34:22

Docco对于prozedural编码风格来说是很棒的。如果你想记录一个应用程序接口,coffeedoc是为你准备的。

票数 15
EN

Stack Overflow用户

发布于 2012-07-29 12:36:05

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

票数 7
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/5850544

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档