问题标签 [jsdoc3]

我试图让我的 JS 文档正确。我正在使用 Dojo，以及基于它构建的其他一些复杂的框架，我将省略细节。关键是这个框架使用了 AMD 模块。我希望我的 JSDoc 工作。

这是我到目前为止所拥有的：

结果：

这个结果还不错。但它推断我的成员是静态的。WebStorm 似乎将它们正确地推断为成员，但 jsdoc3 生成器却没有。从我读到的内容来看，我不应该指定@memberof，因为@lends 应该负责这一点。有什么我做错了吗？任何一般性建议将不胜感激。我阅读了 JSDoc3 文档，但是在将 AMD 添加到等式时，很多结构似乎都模糊了。

导航中Global缺少菜单，同时：

• 文件global.html存在
• 未使用模板时，该Global条目出现在正确的 TOC 中

是否有特殊设置可用于要求DocStrap Template将Global菜单添加到导航？

以下是我的设置：

Gruntfile.js

jsdocconf.json

I've installed JSDoc and JSDoc 3 Tool from npm.

The software installed successfully, executed the command (jsdoc -r=doc file.js), and the folder with files was generated.

However, the mark-up is ignored and the index.html links only to the following path, describing the global class:

Where have I strayed?

JSDoc 有一个@readonlydoclet 标签：

@readonly 标记表明一个符号是只读的。

例如：

但是，我真正想要传达和记录的是，公共消费者应该将属性视为只读 - 但成员不是恒定的。

内部代码可以并且确实修改了此类成员：只读 doclet 标记用于 API 使用者。（如果 API 使用不正确，他们会感到羞耻！ - 但不是我关心的问题。）

有没有一种在 JSDoc（标签）中表达这个概念的好方法？尤其是，

什么是表达“预计内部代码修改此只读成员”的好方法？

当然，在文档中除了 doclet 标签之外，没有明确地写出这样的内容。

我最初希望 JSDoc 能够轻松地接受“@readonly private”或类似的东西，但事实并非如此。使用自定义标签的问题是它是在本地引入的，在标准模板中没有直接的外部含义或应用程序。

我想为添加为Object.defineProperty. 我想这样的事情可能会奏效：

但是生成的 JSDoc 解释没有这个属性：

记录此类属性的最合适方法是什么？（可能是插件？）

我正在尝试记录一个用 JS/NodeJS 编写的非常广泛的（对我而言）代码库。JSDoc 似乎是唯一可用的有效工具，但也存在挑战。以下是我想知道如何记录的两个：

1）我“需要”一个模块（Buzz），然后设置一个监听器：

2) 使用 'Vue.js' 时，现在需要使用函数来设置属性，这意味着函数内有函数作为属性。下面是我让 jsdoc 记录函数的一种笨拙方式，但显然它没有任何意义，因为真的没有 ae-admin '类'。

有趣的是，JSdoc 看起来真的很像 javadoc，而 js 范式是事后才想到的。无论如何，任何帮助将不胜感激。

我一直在尝试使用 JSDoc 记录以下代码：

但是greet在生成的 JSDoc 文档中找不到该方法。我究竟做错了什么？

我想知道记录参数（这是一个对象）及其所有属性的正确方法是什么。

1. 如果我理解正确方括号的意思是“可选”，对吗？
2. 我用来描述对象属性的语法是否有效？
3. 该reqSettings.retryInterval属性是一个数字，但我无法找到包含其单位的方法。有没有办法表明这个数字以毫秒为单位？

编码：

我可以以某种方式使用 JSDoc 进入编辑器自动完成功能吗？

我正在相关的脚本编辑器中创建一个包含大量代码的大型谷歌电子表格。

当我在 LINE 1 上写句点时，我得到了自动完成帮助（见下面的代码），但在 LINE 2 上写句点时没有。在 LINE 2 上写句点时，是否可以使用 JSDoc 语法来获得自动完成帮助？

我没有成功地让它适用于普通的 javascript 对象和电子表格相关的对象。我对两者都感兴趣。

是否有用于记录可选 JavaScript 参数的正确语法，其中可选参数位于函数头的中间（想想 jQuery、Gulp 等）

我已经以标准方式记录了该功能，并且效果很好。问题是当我尝试将第二个参数设置为最后一个变量时（在未使用可选参数的情况下），我的 IDE 会感到困惑。

例子：

如果重要的话，我正在使用 JetBrains 的 PHPStorm，它主要使用 Google Closure 文档样式。虽然我正在寻找一种更通用的最佳实践方法。

我怀疑我可以做一些丑陋的事情，比如：

但这并不能像我想的那样准确地描述这种情况。我希望因为这正在成为一种常见的结构，所以有一些东西可以正确处理它。