问题标签 [jsdoc]

我有一些用 CoffeeScript 编写的代码，我想使用 Google Closure Compiler 优化生成的 JavaScript，因此需要使用 JSDoc 记录这些文件。

我的问题是，如何记录 *.coffee 文件以生成包含用于闭包编译器的工作 JSDoc 的 javascript？

还有一个问题：有没有办法在 *.coffee 中保留单行注释？

工具包

我正在尝试记录我的课程，但我使用“self”var 仅公开公共方法。

jsDoc可以找到类名，但是找不到方法、字段、属性等...

这是我的一门课：

有什么建议我应该如何解决这个问题？

ps：我正在使用 Knockoutjs 和 jQueryMobile

编辑：

谢谢！快到了......我试着做这样的事情：

jsDoc 将其显示为“self.events”而不是“events”

我正在尝试使用 JSDoc-toolkit 记录我的代码。我的代码首先被一个自动执行的匿名函数包装。我到底如何记录这一点？我几乎整天都在这上面。JS Docs 将无法识别匿名函数闭包内的任何内容，因为它不知道如何处理它。它打破了，我的评论都没有通过。

我的代码看起来像这样。

谢谢！

我正在使用以下函数来修改 Javascript 数组的特定实例的行为。如何注释 Closure Compiler 的代码？ http://code.google.com/closure/compiler/docs/js-for-compiler.html通过编译器运行代码会产生“JSC_USED_GLOBAL_THIS”错误。

看起来我不能使用 @extends 或 @constructor 注释。

我不想修改全局 Array 原型，因为在页面上使用其他代码时会产生意想不到的副作用。此外，在阅读http://perfectionkills.com/how-ecmascript-5-still-does-not-allow-to-subclass-an-array/之后，我认为我的方法是我用例的最佳方法。问题是我只是不知道如何将它注释到编译器

如何用预期的对象属性记录对象属性？例如，如果对象是这样的：

这个点有这样的结构：

反正有没有说该点应该具有 x 和 y 属性？好吧，我当然可以在描述中做到这一点，但我一直在寻找一种更好的方法来做到这一点，比如在我们可以这样做的参数中：

Array当数组元素可以是以下任意一种时，如何在 JSDoc 中记录返回值（和参数）：

• 一种类型（例如String, Array）。
• 一个对象字面量。

在自动格式化 Javascript 文件时，Visual Studio 2010 似乎破坏了 JSDoc 样式的注释。

例如

变成

格式化文档后。

有没有办法解决这个问题 - 自定义 VS，使用扩展等？

我怎样才能正确使用 jsdoc 发表此评论。有任何想法吗？？？

我想分别为每个代码示例添加描述。

例如：

如何在 JSDoc 中做到这一点？

我试图用谷歌搜索它，但找不到任何关于为什么 Google Closure Compiler 和 YUI Compressor 使用不同的注释格式

Google Closure Compiler 使用 JSDoc 格式，其中注释以/** 任何不同格式的注释开始。

YUI Compressor 仅在启动时才保留注释/*!

我注意到大多数库（例如 jQuery）使用/*!

你能告诉我为什么大多数库使用/*!而不是 JSDoc（我猜它很流行？）格式吗？

我找不到 Google Closure Compiler 的任何标志来保持注释以/*!

使用 Google Closure Compiler 解析两种格式的注释文件并保留所有注释的最佳方法是什么？缩小后使用流编辑器替换并再次返回的Shell/*!脚本/**？

非常感谢！