问题标签 [jsdoc3]

我一直在尝试使用 JSDoc3 在文件上生成文档，但我遇到了一些困难。该文件（这是一个 Require.js 模块）基本上如下所示：

问题是，我无法baz出现在生成的文档中。相反，我只是得到一个foo/foo模块的文档文件，其中列出了一个bar成员，但bar没有baz（只是一个指向foo源代码的链接）。

我已经尝试将bar' 指令更改为@property，并且我尝试将baz' 指令更改为@memberor @property，但这些都没有帮助。不管我做什么，baz 似乎都不想出现。

有谁知道我可以使用什么指令结构让 baz 出现在生成的文档中？

PS 我试过在 JSDoc 网站http://usejsdoc.org/howto-commonjs-modules.htmlfoo.bar上阅读类似这样的页面，但它只描述了foo.bar.baz.

我正在尝试在主干模型中使用 JSDoc，所以我有以下profile.js文件：

问题是当我执行 `jsdoc profile.js -d="home/mydocumentation" 时会生成警告

>> 警告：尝试将验证记录为未记录符号配置文件的成员。

并且它没有记录验证功能，知道我做错了什么吗？

在我的 JS 库中，我注意到以下划线开头的文件都没有出现在 JSDoc3 的输出中。这些是使用 @module 标记的，我尝试添加 @public 并使用 -p 开关进行构建，但我似乎无法让它们出现。任何想法如何解决这个问题？

Question: I'm editing and using an open source javascript library that has JSDoc tags in its code. I was wondering if anyone knew of a JSDoc plugin that would allow me to generate a class diagram from the JSDoc tags.

Edit I decided to try out js/uml and found the following. The JS/UML eclipse extension requires an older version of Eclipse (Indigo) and a non-supported dependency library UML2tools. I found the dependencies needed and according to the Eclipse software manager installed correctly. When I tried to enable the uml functionality (having configured the js root), the process would hang. The examples that the group supplies points at single file Javascript. Seems to have trouble with multiple files being referenced.

我有一个遵循这种模式的模块。

然后我有一个过滤器模块的子模块

我不知道如何记录子模块。我已经进行了一些搜索，但没有找到任何其他遵循这种使用 jsdoc 样式注释记录的特定模式的人。任何帮助将不胜感激。

导致 JsDoc 遗漏源链接的最简单方法是什么？我必须定义自己的模板吗？

我有文件 lib.js：

和 test.js

我无法在文件 test.js 中获取“x”变量的文档。如果我以其他方式导入该类，则一切正常：

我使用 intellij idea 13 进行开发。

我有多个独立模块，它们只是类使用的 mixin。

基本上，我的语法是这样的：

该文件被检测为 mixin，但在 API 描述中没有附加任何方法。

我正在使用 JsDoc 3.3 并且找不到为什么这不起作用。

我有一个返回构造函数的 javascript 函数（参见下面的代码示例）。我将如何使用 jsdoc 的 @returns 标记来记录这一点。执行 @returns {MyConstructor} 似乎不正确，因为这意味着我正在返回“MyConstructor”的实例而不是构造函数本身，对吗？

JSDoc 在每个页面的页脚输出一个日期：

因此，每当我重建我的库时，所有文档文件看起来都已更改为 Git。这是不可取的——我只想在这些文档的内容实际发生变化时提交这些文档。

我可以让 JsDoc根本不输出这个页脚吗？