问题标签 [jsdoc3]

使用jsdoc3记录 Web 组件的方法是什么

这是一个使用 x-tag 注册的 Web 组件的示例。

我运行以下命令：

这就是我得到的。我在正则表达式中找不到错误：

我想知道如何使用 JSDoc 记录 jQuery 插件？我的代码是：

我想要@method，$.fn.comments但它不起作用。

有人可以给我一个关于如何正确使用@event标签的例子。

我在这里查看了 jsdoc3 文档：http://usejsdoc.org/tags-event.html 但 我无法让它工作。

我正在使用 nodejs，我在 MyClass/index.js 中有一个模块，它以 MyClass 的名称导出构造函数：

我试图添加

在编译的文档中，snowball出现在全局事件列表中，但是当我点击它时，它会告诉我

提前致谢。

UseJSDoc.org 的@type 页面解释了如何记录数组和对象，而不是对象数组。我的函数接受具有特定属性列表的对象数组，我想记录这些属性。

该函数可能看起来像function foo(people)，并且该people数组可能已由函数的调用者创建为

我想使用{{name: string, profession: string, hitpoints: number}} Person语法来记录对象，但也包括它们必须在数组中的概念。

请注意，底层对象（我Person在上面所说的，虽然代码不会引用任何东西）不是一个合适的类，甚至没有在任何地方命名。我也没有在任何地方定义单个“ Person”来使用@property标记。

用 JSDoc3 记录这种代码的困难可能表明组织不好，我很乐意考虑如何重组像这样的临时对象，主要用作哈希表（关联数组）。

我有一个字符串数组，我不知道如何用 JSDoc 记录它。

这会导致错误。

无效类型表达式“string[][]”：应为“！”、“？” 或“|” 但是找到了“[”。

而且我不知道我是否应该?在类型前面放置以表明它可以为空。

如何在 JSDOC 的函数参数中记录可能的配置属性：

哪个标记用于cfg.minimaxDepth( cfg.*) 参数？

是否可以记录合成aiCfg类型并将其引用为：

或以其他方式？

如何记录以下代码片段？当我保持原样时，Foo.bar没有任何描述。当我添加@memberof标签时，它将被记录为静态属性。添加@instance标签不会改变任何事情。这是相当简单和通用的代码模式，所以应该很容易记录，对吗？我讨厌jsdoc...

我想我正在按照 jsdoc3 文档中解释的方式进行操作。我的 WebStorm 是 8.0.4 版

请向我解释描述此模块的最佳方式：

在这个例子中，我的@public 和@static 注释被忽略，所有@public 方法标记为“inner”，@private 方法标记为“private,inner”，return 语句被忽略。在生成的文档中，我看不到我可以使用哪些方法作为 api（我的代码中的“导出”对象）以及如果我返回

此 API 不会出现在文档中。

生成的文档：