是否有 100% 兼容 Google Closure 注释的 javascript 文档生成器？答案

【问题标题】：Is there a javascript documentation generator 100% compatible with Google Closure annotations?是否有 100% 兼容 Google Closure 注释的 javascript 文档生成器？
【发布时间】：2014-05-23 03:50:53
【问题描述】：

有一些非常相似的问题，但我发现的答案似乎都没有提供正确支持所有 google 闭包注释的文档生成器。 JSDoc 无法正常工作（在编写 3.3.0 alpha 版本时）。

JSDoc 确实工作得很好，但不能像这个例子那样正确处理函数类型：

/**
 * @param {function(string)} cbk     A callback taking a string
 */
var hello = function(cbk)
{
    do something...
}

JSDoc 的结果输出将参数描述为“函数”类型，这不是我在阅读文档时想要看到的，我想查看完整的函数类型以及指向相关文档类型的链接。

JSDoc 确实提供了它自己的回调记录方式，但如果你想进行类型检查，这种方式与谷歌闭包编译器不兼容。

是否有 100% 兼容的使用 google 闭包注释的 javascript 代码文档生成器？

Google 的朋友们，如果您正在阅读本文，如何发布用于闭包库的文档生成器？ ;)

【问题讨论】：

标签： javascript google-closure-compiler documentation-generation

【解决方案1】：

我刚刚找到并测试了一个非常好的工具，这是迄今为止我为这项任务尝试过的最好的工具！它支持我用过的几乎所有标签，但不支持@export...所以我不能接受我自己的答案，因为问题是关于 100% 的兼容性；）

我向任何尝试过 JSDoc 并且对它与 google 闭包编译器结合使用并没有留下深刻印象的人推荐这个工具。 http://www.seehuhn.de/pages/jvjsdoc

当前版本在 Windows 下存在一个错误，该错误会为某些 URL 生成反斜杠。但修复很简单，只需将relpath(x, y) 的所有用法更改为relpath(x, y).replace('\\', '/')

【讨论】：