问题标签 [jsdoc3]

i) 可以在模板中实现继承层次结构吗？

ii) 我看到的所有列表方法都是按字母顺序排列的模板，它们可以按照与源代码中相同的顺序列出吗？（我很欣赏这对于 ES5 并不是特别需要，但是对于 ES 2015 现在具有类似 OOP 语义的语言，我认为它或多或少是标准的。）

通过早期例如 JSDoc3 在野外生成 ES 2015 文档（并说明我的观点），https ://bitbucket.org/gso/eonjs/src/ （滚动到“支持”）。

我有一个 AngularJS 工厂，我正在尝试生成使用 Jsdoc 的文档。逻辑如下：

在另一个文件中，我有：

我遇到的问题是我想为 BaseService.create 方法生成文档作为 BaseService 文档的一部分。同样，我想为 ChildService 部分中的 ChildService.childPublicMethod 函数生成文档。但是目前没有为 BaseService.create 创建任何内容，并且 ChildService.childPublicMethod 的文档已添加到工厂模块中。我曾尝试使用@lends 和@alias，以及各种模块/类名的组合作为@memberof 行的一部分，但到目前为止，没有什么能给我想要的结果。任何建议都非常感激。

我正在尝试为一组简单的 JS 代码（如下所示）构建文档。如果我使用 gulp，文档会按照我的预期创建。如果我使用 CLI，则文档不完整。

这是我的 JS 代码：

我的吞咽文件：

我的命令行：

rawconf.json：

原始包.json：

我从 Node.js 命令提示符运行 gulp 和 jsdoc 命令。

gulp 的输出是以下文件：

CLI 的输出是以下文件：

我可以将一些小的差异归结为 jsdoc 的 gulp-jsoc 版本（3.3.0-alpha5）和当前版本（3.3.0-beta3）之间的差异。

但最大的区别是，虽然在 gulp 输出中，我可以找到关于的信息，但在 CLI 输出中的任何地方testFunction都找不到任何信息。testFunction我什至搜索过 HTML 代码——什么都没有。

那我是不是做错了什么？我只是想在这一点上实现平等，而且我已经用尽了我可以在网上找到的所有文档。

我有一个类，它在某些方面就像一个数组。

首先有一个通用部分，可以使用点符号访问，例如：

即有 Array 类型的通用属性，可能记录如下：

但也像数组一样，它具有某些特定的方法

loaddata 将是 myclass 的成员并具有字符串参数

我看不到如何指定具有已知成员的类以及一些可能具有任何名称但始终属于特定类型的通用属性。

我有以下 JavaScript。

它是一个 RequireJS 模块，将其函数命名为对象字面量。我提到：我如何 JSDoc 一个嵌套对象的方法？了解如何标记 JSDoc 符号。

我在一个 grunt 任务中运行 JSDocs 3.3.0-beta3，private: true但在模块页面上没有私有方法或 publich 方法的参数。

这是此 JSDoc 代码的输出：

我正在尝试使用 JSDoc3 记录一些旧代码，并且我一直试图让它在文档中包含实例方法的参数 - 或者根本将任何东西显示为实例属性。我怀疑问题是代码不遵循在 javascript 中伪造类的预期习语，但我想在开始重写任何内容之前记录所有内容。我试图用实际代码的结构来做一个问题的小例子：

我希望所有三种方法都作为实例方法出现在生成的文档中。实际上，methodA显示为静态属性，而methodBand methodC（遵循此处的建议）根本不出现

如何让 JSDoc3 记录实例方法及其参数，而无需重写代码？

这是代码：

为什么 IntelliJ 说 {Me} 没有定义？

我正在使用 JSDoc 进行参数文档。

很清楚如何记录 的参数类型many_prompts，但是记录它返回的函数的正确方法是什么？

我正在寻找扩展 jsdoc（尤其是 docstrap）。我有一个 nodeJS 应用程序，想将 jsdoc 导航拆分为控制器、视图等。通过创建我的自定义标签，我已经在一定程度上做到了这一点，@controller并设法让它被 JsDoc 捕获，类似于@module它生成页面（带有描述）。但是，我的问题是涉及与例如位于“module.exports”功能的控制器相关联的功能。生成的文档基本上忽略了该@controller 文件中的任何其他功能。我怎样才能捕获这些功能。

下面是一个例子：

我正在使用带有 JSDoc 的 commentsOnly 插件，我认为它按预期工作，但我希望有不同的行为。当为返回代码的链接生成行号时，它会从仅生成的注释文件中提供注释的行号。这使得生成的链接没有价值，因为文档用户希望链接到源文件中的评论，而不是仅评论文件（据我所知，这甚至不可用）。

有谁知道将行号报告为源文件中注释的第一行的方法。

谢谢-马特