问题标签 [jsdoc]

Google 的 Closure 编译器有一个“@typedef”标签，但可以在代码中使用它们吗？（我知道它会起作用，但它会皱眉吗？）

所以这是我的类型

然后我可以在我的 JSDoc 注释中使用该类型。

这允许我的 IDE 自动完成传递的参数

所以声明的对象不会在代码中的任何地方使用。

那么这样可以吗？还是有更好的解决方案？

I have to test all my js files through command line in development environment before push to production.how should i integrate this 3? so that i can run

similarly jsdoc to produce my jsdoc style api documents.

any idea or suggestion will be highly appreciated.

我希望我的代码（如下所示）可以使用 JSDoc(v2.4.0) 生成描述对象文字的每个属性的文档，但它不起作用。有谁知道如何使用 JSDoc 从使用 getter/setter 的代码生成文档？

我想知道如何使用jsdoc：

有没有人用 JSDoc 记录过 BackboneJS 代码？

我在注释 Backbone 构造时遇到问题，例如：

任何建议表示赞赏。谢谢。

当我使用 jsdoc 生成 doc 文件时，会出现一些警告

为什么？

但是我该如何描述参数对象的结构呢？例如它应该是这样的：

有没有办法避免为@property 和@param 键入两行单独的行，如果如示例中所示，在构造函数上参数和属性的名称相同。

相关：在 JSDoc 中记录开放式参数函数的正确方法

我有一个通过访问arguments变量接受多个数组的函数：

现在，我知道除此之外的每个参数options都是一个包含值得记录的值的数组：

我不考虑将（冗长的）描述放在可变参数行中。

@param {...} 包含搜索词、替换及其选项的数组；index 0：函数内的搜索词；1：替换文字；2：可选选项（catch_errors：捕获错误并记录它，escape：在替换文本中转义美元，pos：“L”用于将替换放置在搜索词之前，“R”用于将其放置在之后）不是可读的解决方案和类型不可见。

有没有办法记录变量参数的类型和值？

上面看起来很难看，但它应该让您了解我想要实现的目标：

• 记录变量参数的类型（在本例中为数组）
• 记录这个数组的值
• 记录此数组中对象的属性

为了懒惰，我使用了数组而不是对象。其他建议总是受欢迎的。

我第一次使用 jsdoc，它似乎不喜欢我的语法，我找不到它喜欢的任何东西：

问题 #1：由于某种原因，我收到“警告：尝试将someMethod记录为未记录符号 Cube 的成员”的错误。如果我把那个包装函数留在里面。如果我把它注释掉，它就可以工作。

问题 #2：我的课程有点奇怪，当我说@lends Cube.prototype将以下对象应用于Cube而不是cubeFrame. 我收到与 #1 几乎相同的错误：“警告：尝试将 getVoxel 记录为未记录符号cubeFrame的成员。”。我不想cubeFrame被记录，我希望它的原型进入Cube文档。

我可以重新编写这两行并生成文档（然后是无效代码），但我不想每次进行更改时都必须重新编写代码来生成文档！