问题标签 [jsdoc]

我个人不是生成文档的忠实粉丝（我更像是一个“阅读源卢克”的人），但我可以看到这些文档对其他人有何用处。现在，通常他们生成文档不会影响我，除了一件事：@method。

大多数 JSDoc 注释（例如@param）对于阅读源代码的人仍然非常有用，但@method100% 是多余的：

所以，我真的很想避免数百@method行代码把我们的代码弄得乱七八糟。但是，我的同事认为@methodJSDoc 生成器（他正在使用 YUI 生成器）必须能够生成类的方法列表。

所以，我的问题（对那里的 JSDoc 专家）是：有没有办法生成有用的文档（即使用列出的类的方法）@method？或者，如果@method确实需要，是否有任何 JSDoc 生成器可以从函数名中推断出方法名，这样我就可以@method不用了@method addFive？

PS如果有一个“你做错了”类型的答案，它没有直接回答问题，但提出了一种完全避免问题的方法，我很想听听；我当然不是 JSDoc 专家。

我正在寻找可以在我的项目中使用的 JSDoc 解析器。我正在寻找可以传递 JSDoc 注释并接收该注释含义的结构化描述的东西。我见过的大多数工具似乎都能够将 JSDoc 注释转换为 HTML 或其他格式。我正在寻找可以提供可用于输入其他工具的评论的中间表示的东西。

有没有我可以使用的工具或库？

我知道周围有各种各样的 JSDoc。似乎每个 JSDoc 解析器的实现都可以识别自己的一组标签。例如，考虑http://usejsdoc.org/和http://www.techrepublic.com/blog/programming-and-development/create-useful-relevant-javascript-documentation-with-jsdoc/之间的标签差异451 .

在这一点上，我只是感到困惑。是否有 JSDoc 的规范实现或广泛认可的核心标签集？是否有JSDoc 的最佳实现？

编辑

正如下面评论中所问的，这个问题的原因是我需要解析 JSDoc 评论以与我们正在创建的工具一起使用。看到这个问题”：有没有用 Javascript 编写的开源 JSDoc 解析器？

我担心我将不得不推出自己的解析器，如果这样做，我需要知道需要支持哪些标签。

但是，在更深层次上，我担心没有一致的规范（或参考实现）。这让 JSDoc 对我来说有点特别。

我正在尝试记录函数生成器但没有成功，这是一个示例：

我应该如何记录 genericObjectGenerator 及其 specificObject 函数，以便让 JSDoc（和 IntelliJ）正确解析 sayHello。

我的一个类生成了一个 jsDoc 错误，因为它正在扩展 goog.Disposable。我正在使用@extends 来指定这一点，但它仍然无法正常工作。使用闭包 linter 编译文件时不会出错。代码可以在这里找到”

在声明扩展的模块时，将dojo/Stateful定义 getter 和 setter 的模式，_xxxGetter并将_xxxSetter其表示为.get('xxx')and .set('xxx')。

所以，我的问题是，如何最好地用 JSDoc 记录这一点？@function似乎不支持提供替代方法名称，无论如何，这是参数值的变体，而不是方法名称？

那么，JSDoc 是否对这个模型有任何内在的支持，还是我只需要为这些东西编写明确的文档？

我有一个 JavaScript 单例定义为：

在详细模式 (-v) 下不会打印任何警告，但文档仅报告“com.mydomain.ClassName()”，其中“A description here”作为描述......我如何也为 ClassName 的方法生成文档？

我有一个通过定义一些实例属性的类，Object.defineProperties我很难让JSDoc 3识别它们属于他们的类。

这是我正在使用的简化版本：

当我运行 JSDoc 时，我得到了mymodule、Example、foo和的输出bar，但没有得到foobar。如果我删除 的@memberof标签foobar，它将被注册为全局。我已经尝试过@memberof mymmodule~Example，添加@lends到Object.defineProperties调用和传递给它的对象，并将其转换为Object.defineProperty，但结果没有改变。

我怎样才能证明foobar属于Example？

我知道已提出问题 1731，要求在 Google 脚本编辑器中预览 jsdoc。http://code.google.com/p/google-apps-script-issues/issues/detail?id=1731

当我们等待实现它时，预览我添加到已发布库中的 jsdoc 注释的最佳方式是什么，而不需要我创建新版本？

我将 webstorm ide 与 nodejs 一起使用。当我创建模块并需要它们时，我没有代码完成。

例如：

测试.js

main.js

我还没有在 jsdoc 3 文档中找到任何关于模块用法的信息。:S