是否有与Google Closure注释100%兼容的JavaScript文档生成器?

时间:2014-05-14 11:35:24

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

有一些非常相似的问题,但我找到的答案似乎都没有提供适当支持所有谷歌闭包注释的文档生成器。 JSDoc无法正常工作(在编写版本3.3.0 alpha时)。

JSDoc确实运行良好,但不能像这个例子那样正确处理函数类型:

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

JSDoc的结果输出将参数描述为类型' function'这不是我在阅读文档时想要看到的内容,我希望看到完整的函数类型,其中包含指向相关文档类型的链接。

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

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

谷歌的男人和女孩,如果你正在读这篇文章,那么发布用于闭包库的文档生成器怎么样? ;)

1 个答案:

答案 0 :(得分:0)

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

我向所有尝试过JSDoc的人推荐这个工具,并且结合谷歌闭包编译器并没有给它留下深刻的印象。 http://www.seehuhn.de/pages/jvjsdoc

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

即可