问题标签 [jsdoc3]

我想知道是否可以从一个模块链接到另一个模块的属性/方法。

到目前为止我已经尝试过但没有工作：

我的模块遵循这种模式：

有没有办法实现我想要的？

I have a function with an array of objects as parameter and would like to describe the parameter (including the properties of the objects in the array) using JSDOC like in this example:

where filter is something like this:

How would I document the properties id and value in jsdoc3 ?

我试图让命名空间与显示模块模式一起工作。我的代码类似于以下内容：

但是，JSdoc 没有看到获取 getDataSeller 文档。如果有人可以给我一种方法以及上述方法不起作用的原因，那就太好了。

我使用以下命令从 javascript 文件生成 html。

命令的输出

我想在使用 Jsdoc 生成文档时自动生成这样的子菜单。有可能这样做吗？如果是，请告诉我它的完成方式。带有子菜单的示例文档

（已编辑）使用 ( ReadTheDocs )获得了一种更简单的文档处理方式

我想知道使用 require 和 jsdoc 从 JavaScript 模块导出枚举的规范模式。现有的示例和问题似乎只考虑本地私有枚举。我的目标是尽我所能拥有最优质的文档和智能感知/代码完成。

这是我目前最好的尝试：

这里有一些细节导致我采用这种方法：

1. 高度是枚举。它是静态的。
2. Object.freeze 似乎是最佳实践。
3. 执行 LawnMower.heights = Object.freeze(...) 会阻止 Visual Studio 的智能感知工作。因此，我分两步进行。
4. 添加了@readonly，虽然我认为它没有任何作用
5. mow() 函数引用了 LawnMower.height，但似乎没有任何工具对它有太大作用。

我们的团队正在使用 Visual Studio、Ace+Tern 和 Atom。使用上面的模式，当我们编写这样的代码时：

希望智能感知能够显示参数名称、类型和描述。如果填写“LawnMower.heights”，则可加分。为我们。（Visual Studio 为 C# 执行此操作）。

结果：

• Atom 似乎在这里完全忽略了@param。
• Visual Studio 告诉我们参数是高度，但没有提供类型或描述。
• Ace/Tern 显示高度的 @jsdoc 注释行。

具体问题：我是否正确编写了@param 行？我相信名称路径“LawnMower.heights”是指代 LawnMower 的静态成员的正确方法。

参考：

1. 如何用有限的可能值在 jsdoc 中记录字符串类型
2. 枚举作为 JSDoc 中的 @param 类型
3. 如何记录接受一组预定义值的参数？
4. http://usejsdoc.org/tags-enum.html
5. http://usejsdoc.org/about-namepaths.html

我正在处理我试图评论的 WebStorm 实时检查中的模块模式。
而且我不想使用 AMD/CJS。

假设“MyAnotherClass”具有相同类型的注释。我的问题是当我尝试这个时：var test = new MyAnotherClass(s);WebStorm 告诉我Method 表达式不是 Function 类型。

我能做些什么 ？

如果您需要更多信息，请告诉我，并为我的英语不好感到抱歉。

L.

编辑：似乎删除带有参数定义的第一个评论块正在解决问题......但我觉得这不是最好的方法。

EDIT2：与抽象类的属性相同的问题

或者

JSDoc@type文档没有明确说明它。

我总是大写String，Number因为我的理解是我需要使用构造函数名称。在 JavaScript 中，String作为Number构造函数存在。

我注意到不一致：我将其他原始类型（例如null, undefined）定义为小写。

原始类型名称需要大写还是小写？

我使用 WebStorm 作为我选择的 IDE 并编写了很多 JavaScript。自动补全很好，但在 JavaScript 的情况下仍然......还有待改进......这至少是我所经历的。

例如

有两个类，A和B：

我的问题

在 IDE 中：当我开始输入时a.，自动完成功能启动并显示data (A)和name (A).

但是当我b.首先输入时它没有显示值，只有在我添加了/** @augments A */. 没有它，WebStorm 就没有它。

但我遇到的主要问题是：当我输入时b.data. ，它不会为我提供braz (B)选项。

是否有人对 JavaScript、@JSDoc、WebStorm / IntelliJ 有经验并知道解决方案？

我能做的是编写重复的代码并从上面复制this.data对象并添加我需要的属性。

我也可以做的是直接把this.dataup to的内容this。但这不是我想要的。

提前致谢！

如何使用具有以下形式的 jsdoc 记录 API（单个文件）

我唯一的想法是在@namespace导出和@lends匿名函数之上添加，但这会导致文档为空。