问题标签 [jsdoc]

如何使用 jsdoc 格式化嵌套数组和对象？

这是我最好的猜测：

如何指示对象由某种字符串索引？

如何定义嵌套数组？

也不确定在可选参数中放置方括号的位置。

问题是 Komodo 智能感知没有看到以这种方式定义的对象方法：

键入“应用程序”。没有结果。

但是，定义如下对象可以正常工作：

如何使自动完成在第一个示例模式下工作？

我想在 Eclipse/JSDT 中指定实例变量的类型，如下例所示：

但是，IDE 无法识别x. 另一方面，像这样的声明

确实有效，即在这种情况下，x已知具有 a 的类型Node。

如果我添加

对于第一个示例，x将被称为类型变量Node。但是，此代码不会运行。

我将如何在闭包中注释这个名为 bar 的私有函数？

像这样？

还是像这样？

或者甚至是两个文档的组合？但是我会重复我认为的函数参数和返回类型的信息。

整个闭包示例的完整 jsDoc 示例。“私人”功能不再有@private jsDoc（如“约翰”所说）。

我试图了解用于记录与JavaScript Closure Compiler一起使用的 JavaScript 的JSDoc 样式。我有下面的 JavaScript 代码

当我对此代码进行高级编译时，我收到 2 个警告。

该函数append返回对封装对象的尊重。它返回的变量 , SingletonStringBuffer, 被声明...所以我不确定什么是错误的或如何纠正它。

我有两种类型的模块：

Require.js 主文件：

中介模式：

如果可能的话，我如何用 jsdoc3 来记录这个？

我目前正在重构我们拥有的一些 Javascript 代码，除此之外，我已经对其进行了更改以利用显示模块模式。代码看起来更整洁，工作正常，但我在大纲视图中看不到这些功能。我将顶级命名空间 var 视为 var，但您无法扩展它以查看其中的函数。

假设以前的代码看起来像这样：

在这种情况下，您可以在大纲视图中看到这两个功能。但是如果你把它改成这样：

然后大纲视图只向您显示 myNamespace 变量。我尝试过寻找，但找不到真正能正确显示层次结构的视图。有谁知道查看这个的方法，或者是 Eclipse 无法做到这一点的情况？

我在 API 中有一个简单的方法，允许使用 JSONPath 搜索对象。由于初级开发人员对它的语法非常陌生，我决定在 JSDoc 注释中提供一些示例。然而，这里有一个问题， -@符号被视为新 jsdoc-tag 的开始，因此描述被破坏。

问题：如何使 NetBeans（或一般的 jsdoc）忽略@特定代码块内的符号？最好在@example块内。

因此，此代码将在工具提示中显示未修改：

$..book[?(@.price<10)] // - filter all books cheaper than 10

此外，@example, <code>, <pre>- 没有帮助。

Html 实体在工具提示@中转换为，但它在代码本身 ( )中看起来不可读，并且它仅在主要 jsdoc 文本中工作......@$..book[?(&#64;.price<10)]

我正在使用 jsdoc 工具包来记录一个项目，并且我在记录另一个私有对象中的私有对象的问题中。

我收到了这个警告：

警告：试图将连接记录为未记录符号 testObject 的成员。

但是 testObject 在我的 Docs 输出中显示为“ {Object} testObject ”

这是javascript文件测试：

该@param标签允许记录属性，例如

我将如何记录@this 标签的属性？

我想知道是否有从事该项目的人知道。（文档仍在创建中...）