问题标签 [jsdoc3]

我正在尝试使用 jsdoc 记录猫鼬模型方法。模型的方法属于模型，因此我希望将其视为成员方法。

该文件还包含一个顶级@module models行。

目前，我收到一个模块页面，其中包含指向我的类定义的链接，以及一个记录类定义的页面，但该方法没有出现在这些页面中的任何一个上。当我删除@memberof时，该方法会出现在模块页面上。我想把它放在课程页面上。

我缺少 jsdoc 文档的哪一部分？

我有一个 JS 数据对象，它只包含一些静态项目。我不是在 {}; 中一口气宣布所有内容。我从一个空对象开始，一次添加一个项目。例如：

我想用 JSDoc 记录我的 ScapeStuff 数据对象，并将注释行替换为// water描述该事物的 JSDoc 注释。

我可以在上面添加一个巨大的 JSDoc 注释ScapeStuff = {}，并用于@member为每个属性项编写描述，但文件可能很长，所以我真正想要的是在源代码中的每个属性的 JSDoc 注释之前财产。

在这种情况下，内联 JSDoc 注释的正确方法是什么？

我正在使用 jsdoc 记录我的代码，到目前为止一切顺利，我有如下评论

它出现在 html 文档中，例如

我希望它看起来像

希望我说清楚...

我如何告诉 JSDoc 返回的对象的结构。我找到了@return {{field1: type, field2: type, ...}} description语法并尝试了它：

虽然解析成功，但生成的文档只是说明：

我正在开发一个 API，需要人们了解他们将返回的对象。这在 JSDoc 中可能吗？我正在使用 JSDoc3.3.0-beta1。

我的模块具有以下 AMD 结构。

我正在努力使用 JSDoc 使其与我的模块一起使用。到现在为止，我可以让它像

如您所见，它正在工作。但是我希望在函数声明上定义我的文档注释，而不是在我将它们添加到模块的地方。我想实现这一点：

后一个是我想要实现的，但遗憾的是它不起作用:(

有任何想法吗？干杯

编辑：

我取得了一些进展。请注意，如果我只写这个：

那么输出为空。JSDoc 无法正确生成文档。虽然如果我@method <name>为我的函数添加注释，那么它会自动运行得很好。有趣，但仅添加一个@method没有名称的注释是不够的。我的最终工作解决方案如下所示：

CLI 标志-p使私有成员出现在文档中。

附加信息

通过我的示例代码，我只能通过一种方式制作内部链接：

我目前正在使用 JSDoc 记录我的一个 API。虽然这很好用，但真正让我烦恼的一件事是重复文档的出现。一个常见的例子是属性及其 getter 的文档：

我想每个人都在这里看到了这个问题。该属性实际上记录了 3 次（私有属性本身、getter 方法描述和方法的返回值）。简单地将方法的描述更改为类似的东西Returns the state并不是一个真正的选择，因为我通常在文档输出中隐藏私有属性。

我对此类情况是否有最佳实践以及其他人如何处理这种情况感兴趣。作为一个痴迷于 DRY 的人，似乎应该有更好的选择来处理这些情况。

我正在将 Parse 用于移动应用程序，我有一些云代码功能，我想使用 JSDoc 生成文档。

如果我这样做：

JSDoc 不生成文档。

但是，这样做有效：

是否可以记录我的云代码功能？

为了让 JSDoc 满意，我正在努力理解我当前的 gulpfile 中缺少什么。

下面的代码不会引发任何错误，但是查看生成的文档的索引页面，很明显我的文档没有被格式化。

我在这里想念什么？

首先，这是我要记录的功能。

接下来，这是我的 gulpfile.js

一旦我运行gulp js-doc，它就会创建 docs/ 目录并构建文档。但是，在浏览器中访问 index.html 页面会发现实际上并没有生成任何文档。当我查看app.js.html由 JSDoc 生成的另一个文件时，我看到了我的代码块，但其中没有任何内容被解析并转化为实际文档。请参阅下面的屏幕截图。

我想我缺少对 JSDoc 或 Gulp 的一些基本理解。

我在理解联合中命名空间和模块的目的时遇到了问题。例如我有一堂课Game.utils.Matrix。我想注释Game为命名空间、utils模块和Matrix类：

它创建了一个文档，Matrix类的名称路径是Game.utils~ Matrix，但是如果我点击Module链接，它的名称路径Module: utils没有Game命名空间前缀，如果我点击Game链接，它不包含utils模块链接。

此外，我无法向该模块添加另一个类，因为该类未显示在utils模块选项卡中：

问题是：记录命名空间和模块的正确方法是什么？它们各自的用例是什么？

在 JavaScript 中，使用本质上是参数列表的数组是很常见的：一个小的固定长度，以及每个位置的已知类型。对于 ECMAScript 6 尤其如此，它引入了诸如rest 运算符、 spread 运算符和迭代器协议之类的特性。

我想记录一个返回迭代器对象的函数，用于迭代键/值对。理想情况下，我想具体说明它的类型。是否可以使用（任何）JSDoc 做到这一点？这是我最近的尝试，但我不知道它是否有效：

jsdoc-to-markdown抱怨语法，但这可能是在他们的最后，而不是 JSDoc 3。如果是这样，我稍后会向他们发送错误报告。

编辑：这是一个可能返回的示例对象：