问题标签 [jsdoc]

我的大多数 Javascript 函数都相对简单，并且需要它们的副作用：我使用 jQuery 来操作 DOM 或进行 Ajax 调用。我更喜欢以“显示模块模式”的风格编写我的函数。

我刚刚发现JSDoc-注释 Javascript 文件有一个好处：在注释的帮助下，Eclipse 的 JS 开发工具可以解析我的 JS 文件并填充 Eclipse 大纲视图（否则它将是空的）。

现在我想知道注释的要点或良好做法是什么？我不习惯。

google JS style guide 说了一些关于 JSDoc 的内容：建议只使用可用标签的子集，以及其他建议。

现在，我想出了这个模板（这段代码没有做任何有用的事情）：

我应该在这里使用 JSDoc 标签 @function 或 @memberOf，还是两者都使用？@field 标签呢？return 子句也应该是 JSDoc'umented 吗？用哪些标签？我真的不应该使用@public 标签吗？我觉得这里很有用。

有什么建议吗？有谁知道小型项目的良好实用的 JSDoc 样式指南？

Does anyone have any experience in documenting/structuring angularjs projects so the JSDoc can generate nice comments (for your directives, controllers, filters etc.) in an HTML format? At the moment it generates one file with the _global class that points to the namespace of my app with couple functions and that's it...

Or maybe there is a better way to generate html version of doc blocks in angularjs?

PS: I am using standard jsdoc syntax to document my code (@param, @return etc.)

Update: My specific question is: Is there any way to generate html documentation for angularjs doc blocks to cover all controllers/directives/filters etc.? When ran JSDoc command line utility it covered only about 5% of my code in the HTML report...

Thanks!

我正在尝试使用 JSDoc(3) 记录一个 Javascript 文件，如下所示：

现在文件（称为config.js.in）本身不是有效的 Javascript；该文件通过 Makefile 运行，该文件用适当的值替换@HAVE_BLUETOOTH@.

当我尝试对此运行 JSdoc 时，它（可以理解）由于文件中的语法错误而犹豫不决。

有没有办法告诉 JSDoc 忽略这个文件中的所有代码，而只考虑注释？（我可能必须@name为每个 doclet 添加标签以将文档与代码完全分开；这很好）。

就像是：

如果可能的话，我不想修改文件的代码部分（我正在向现有项目添加文档）。例如，我可能会绕过它

这将使文件再次具有有效的 JS 语法，以便解析器不会抱怨，但这也意味着我正在修改我想要避免的原始文件的代码（我更喜欢只添加文档）。

干杯

我试图找到如何让 JSDoc3 自动生成来自其他模块的类的链接。我觉得很难用语言来解释，所以让我举几个例子。以下脚本生成预期的输出：

也就是说，JSDoc3 正确地生成了从 someFunc 的参数列表到 SomeClass 的类描述的链接。但是，当我将 SomeClass 放在外部模块中时，我似乎无法让 JSDoc3 生成链接：

现在 JSDoc3 正确生成了这两个文件的文档，但它没有将 someFunc 的参数类型链接到 SomeClass 的页面。我尝试替换@param {SomeClass}为：

• @param {SomeClass.SomeClass}
• @param {SomeClass/SomeClass}
• @param {@link SomeClass}
• @param {@link SomeClass.SomeClass}
• @param {@link SomeClass/SomeClass}

但是这些都不起作用：在所有情况下，文档都只是在大括号内显示文本（即使我使用了@link）。

如何让 JSDoc3 正确生成指向外部模块的链接？

我是 IntelliJ Idea 的新手 我想为 JavaScript 核心添加 jsdoc 这意味着，当我在.getElementsByTagName()方法等 javascript 元素上按 ctrl+q 短键时，我想查看文档，但没有任何内容！

有什么办法吗？就像在库 jar 文件附近添加文档 jar 文件以显示文档一样。

谢谢莫希

如何让 PhpStorm 理解这样声明的变量的类型：

PhpStorm 只知道最后一个变量类型并建议它的方法/属性，但它不知道变量“a”和“b”的类型。

是否可以在 PhpStorm 中记录类型并符合 JSLint？如果是这样，怎么做？

我正在尝试覆盖超类的方法并使用 Google Closure Compiler 编译代码，但我收到有关错误类型的警告。

如您所见，我没有更改 super 方法接受的参数类型，也没有更改返回的类型。

有谁知道如何解决这个问题？谢谢。

为了澄清，这里是各个方法的定义。

如果我在 javascript 文件中有一个私有函数：

当我启动一个文档块时，IntelliJ 将有助于将它存根，所以我得到：

我已经将JsDoc配置为将带下划线的函数视为私有函数，所以我宁愿它不添加到评论中。是否可以配置 IntelliJ 使其不添加@private到评论中？

我有一些返回promise 对象的代码，例如使用NodeJS 的Q库。

如何使用 JSDoc 记录这样的返回值？

我刚刚完成了我的 JS 代码。现在我把它移到了它自己的文件中，现在 PHPStorm 告诉我没有名为 $ 的变量。我该如何解决？（JSDoc能解决吗？）