问题标签 [jsdoc]

我想知道如何使用 jsdoc 为构造函数定义两个签名：

这会产生一个带有 {string} p1 的构造函数。

谢谢你的帮助

我正在使用$.widget()提供方法的 jQuery 的基“类” option()。由于该方法不在我的代码中，因此我没有地方记录该参数。

我试图将 jsDoc 放在默认选项文字中的字段上，但它们根本没有被拾取。然后我尝试在同一个对象字面量上使用@classand@lends标记，但这可能会让人很困惑，因为对象字面量并不是真正的类。

我尝试过的另一种选择是将类似的东西@param options.field description放在构造函数的 jsDoc 中。但是，这样做的缺点是将文档与代码分开。此外，构造函数实际上没有调用参数options，因为它全部由 jQuery 处理。

您的 Javascript 专家如何处理这个问题？是否应该提出一个新标签？

我有类似的东西：

我错过了什么吗？我起床到NS。-> 自动完成：MyAwesomeObject，但我想要 NS.MyAwesomeObject。-> 自动完成：初始化（id）。

当我不使用 Class.create() 时，它适用于其他情况。我用谷歌搜索，解决方案是添加@class，但这对我不起作用。

谢谢！

我目前正在向个人 javascript 模块添加类型注释，但我目前在尝试输入以正则表达式作为参数的函数时遇到困难，但以下尝试均无效：

我只得到：

我应该在声明中使用什么类型？谢谢。

我正在研究使用谷歌应用程序脚本构建一个工具集。问题在于，据我所知，只允许一个级别的组织。您可以创建一个名为 Stopwatch 的库并调用方法 Stopwatch.start() 和 Stopwatch.stop() 这很酷。

我想到的是更像 Utils.Stopwatch().start() 和 Utils.Timer.start() 等。我认为这在 javascript 中当然是可能的，但为了继续破坏 Apps Script 自动完成功能，它需要以某种格式添加。下面是一个做错的例子（给出一个错误），但可能会节省一些时间。它基于这篇文章。

谢谢

我正在使用John Resig 的 Simple JavaScript Inhertance定义类，并使用 JSDoc@lends和@constructs注释对其进行记录，但 NetBeans 不提供代码完成功能。这适用于我使用命名空间定义的模块，因为我直接引用它们。这是一个简单类的示例：

有谁知道记录这些类的方法，以便在 NetBeans 中提供代码完成功能？

我仍在学习 js 并尝试 Webstorm IDE，这看起来很不错（包括跳转到 var/function 声明）。

我可以看到如何获取 jsdoc 评论的模板，但我没有使用它的经验，并且正在寻找如何在评论中提供更多详细信息以及如何查看该详细信息的示例。

I'm writing my own library for the project at work for a browser application and I am having the same old problem deciding how to comment the code.

I'm trying to follow the JsDoc syntax, but will probably continue the Google Closure Compiler way. I may end up using two @return and @returns tags in the documentation, just for portability sake (when I setup the auto-generation of the documentation).

Now, the question, how do you document the return of a custom anonymous object from a function? For example:

JsDoc has an example of how a @param can be documented to expect object with certain fields, but not the @returns tag. Similarly, the Google Closure Compiler documentation of a Record Type is vague and has no example to work it out.

我正在尝试使用 jsdoc-toolkit 在特定模块模式内记录函数，其中命名空间是在模块外部定义的。附加到它的函数位于立即调用函数中。我从工具输出中得到的是：

警告：试图将 isObject 记录为未记录符号 CORE 的成员。

这是代码的简化版本：

我正在尝试使用 jsdoc3 记录我的模块化骨干应用程序。但是，当我尝试通过 jsdoc 运行此代码时，我收到错误“来自未捕获的 JavaScript 抛出的异常：错误：缺少依赖项：Backbone.model”：

当我添加“@extends Backbone.Model”时发生错误。我也欢迎任何关于使用 jsdoc3 记录骨干应用程序（使用 require.js）的替代模式的建议。

提前致谢。