为未注释的 JavaScript 自动生成文档答案

【问题标题】：Auto generating documentation for uncommented JavaScript为未注释的 JavaScript 自动生成文档
【发布时间】：2014-11-10 10:41:58
【问题描述】：

我得到了一个 JavaScript 项目来维护。如果它是 C 或 C++，那么我会通过 Doxygen 运行它并获得一些不错的文档，即使代码中没有 Doxygen cmets。这有助于在我深入研究代码之前对项目进行概述。

我无法让 Doxygen 为 JS 生成任何东西，official web page 上的链接已损坏。

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

【问题讨论】：

我明白了。有什么方法可以改写可以接受的问题吗？
据我所知，更新后的问题不再寻找软件推荐（很好的编辑！）。根据我对this meta guidance 的阅读，它可能比程序员更适合 Stack Overflow，但我不会打赌
感谢您的帮助！我将继续在 Google 上发布任何积极的发现以帮助他人。
别担心（还） - 有 2 个重新投票，我已标记为版主查看
@gnat，非常感谢您的帮助。是你们这样的人让我对 SE 社区充满信心。

标签： javascript doxygen

【解决方案1】：

对断开的链接感到羞耻。我发现 this 可以帮助你，还有一个 SO 问题。

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

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

【讨论】：

“js2doxy - 将 JavaScript 转换为 Doxygen 可以理解的工具”来自您的第一个链接是完美的！