自动生成未注释JavaScript的文档

Question

我已经获得了一个JavaScript项目来维护。如果它是C或C ++那么我会通过Doxygen运行它并获得一些体面的文档，即使代码中没有Doxygen注释。在深入探讨严肃的代码之前，这有助于我对项目进行概述。

我无法让Doxygen为JS生成任何内容，并且official web page上的链接已被破坏。

如何让Doxygen与（未注释的）JS代码一起使用？

Answer 1

对于破碎的链接感到羞耻。我发现this会对您有所帮助，并且SO会对此提出疑问。

js2dox perl脚本基本上将你的js代码（带有注释）转换为伪C ++代码，这些代码的格式正确，可供doxygen使用。您必须向js添加一些特殊注释标记才能正确包含参数，返回代码和类型。这些是特殊标签\ t \ tparam，\ treturn和\ type - 它们不是有效的doxygen标签，但会被转换为C ++代码的正确部分。

可以在jsunit构建中找到js2dox.pl脚本。我不确定为什么它不是doxygen网站的一部分！