问题标签 [jsdoc2md]

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

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

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

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

我在 JS 文件中使用 JSDoc 注释并运行 JSDoc2MD 将这些注释呈现到 markdown readme.md 文件中。我想使用JSDoc中的@example 标记在我的文档中包含代码示例。我在渲染带引号的字符串时遇到了麻烦。

在我的 JS 评论中，我有：

此注释在 json 中变为以下内容：

我有一个自定义把手模板设置，JSDoc2MD 使用它来生成自述文件。在我的车把模板中，我有：

生成的自述文件有 html 名称而不是引号：

因此，降价输出看起来不错，期待引号：

与 JSDoc2MD 一起工作的其他人有这个问题吗？我只是在这里输入错误吗？

我们有一大段 JS 代码，用 jsdoc 语法记录，我们希望以自动方式将其包含在内部 wiki 中。

因此，我正在寻找能够从我们的代码库中使用 jsdoc 自动生成页面的 wiki 解决方案。

任何想法 ？

我正在尝试为我们的 node.js API 创建自动生成的文档。我正在使用 jsDoc 样式的注释和 gulp 来运行生成。我正在使用插件jsdoc2md和这个gulp插件来创建降价样式文档。

当我尝试使用模板时，我遇到了我的 typedef 没有出现在生成的文档中的问题。当我不使用模板时它们会出现

这是吞咽任务

这是我的模板

其输出是带有适当功能和模块的降价，但缺少 typedef。所以我的问题是：

如何让我的 typdefs 在模板中呈现？

文档没有太多。有任何想法吗？

我正在使用JSDoc为我的 JS 库生成文档。从 JSDoc 生成的默认 HTML 内容具有灰色文本并且非常难以阅读。现在，我想将文本颜色更改为黑色/蓝色。有没有办法改变文字颜色或背景颜色？

我的 Ionic 应用程序中有cordova-plugin-camera@4.0.3并且在尝试使用该命令 git commit生成自己的文档时出现错误，它阻止我运行。jsdoc2md

知道如何克服这个错误吗？该应用程序是在云中构建的，因此我对包所做的任何本地更改都无济于事。

我正在使用 jsdoc2md 根据多个文件生成 readme.MD：jsdoc2md --files a.js b.js > README.md

结果提供了未排序函数的列表。如何按字母顺序从所有文件中获取所有函数的列表？

我有一个函数，它是一个 React 组件。它创建的元素具有position:absolute;为了使此属性以可预测的方式工作，父元素应使用position: relatieve;. 我想让这个组件的未来用户知道这个约束。是否有用于此目的的 JSDoc 标签？你如何让这个组件的用户知道这个重要的约束？

在 Javascript 中，我有两个名称相同但参数不同的函数。代码工作正常，但是当我尝试这样做时，jsdoc file.js或者jsdoc2md file.js我得到一个错误Identifier 'info' has already been declared。

解决方案是什么？

我们正在重写我们的 API 文档，我们希望将自定义内容添加到我们生成的 JSDocs 中。例如，此自定义内容可以是可运行的代码片段，这是我们目前在手动编写的文档中拥有的功能（基于 Jekyll 注入动态内容）。有没有办法直接实现这一点，使用 JSDoc 的模板系统和今天的一些自定义代码，或者间接地通过后处理生成的 html 来寻找某种符号？其他可以处理这个问题的 JSDoc 生成器也很有趣。

说，我们可以有这样的东西

将为该代码生成某种自定义代码，该@runnableExample代码将插入一个名为./examples/foo-example.js. 这只是对良好用户体验的建议，而不是它需要的方式。