如何从 Javascript 生成 RTF 文档

Question

我目前正在尝试为项目中的 HTML、JavaScript 和 CSS 文件生成 RTF 文档，就像我可以从项目的 Java 部分中的 Doxygen 所做的那样。

Javascript 文件是 JSDoc 注释的，但我可以轻松地将其更改为其他格式。

我知道 JSDoc、ESDoc 和 YUIDoc。它们都生成 HTML，虽然不是所有的都运行良好，例如 YUIDoc，由于文件名问题跳过了很多文件。似乎它们都没有处理 CSS 文件（或 HTML）。

我也知道 pandocs。我想这可以使用 JSDoc 或 ESDoc 生成 HTML，然后通过 Pandoc 转换为 RTF，但还没有做到。

还有其他解决方案吗？有人已经做过了吗？

即使是部分解决方案，例如只有 Javascript，也会有所帮助。

Answer 1

您可以使用 Doxygen 维护您的工作流程，并且仍然使用适当的过滤器和配置文件中的微小更改来记录 javascript 文件。

Doxygen 手册引用 js2doxy.pl 作为 Perl 脚本来帮助编写 js 文档，但也提醒原作者的页面目前无法实现。

您应该在此链接的过滤器中找到帮助： https://gist.github.com/sarnold/d6294abab8fb573fc49069de62fc549a

如果您选择使用该链接的过滤器，则需要安装 node.js 才能运行它。但您可以选择开发自己的过滤器。

选择过滤器后，您需要更改 Doxygen 配置文件以查找和处理 javascript 文件。

在你的原始配置文件中找到 FILE_PATTERNS 控制标签并调整它的值：

FILTER_PATTERNS =*.js=doxygen.js

doxygen.js 必须是所需 javascript 过滤器的路径。

找到FILE_PATTERNS 控制标签并在列出的终止符中包含*.js。

更改INPUT 标记以指向您的源文件夹。

最后，使用适合过滤器的模式对 js 文件进行注释。 doxygen.js 过滤器在函数和命名空间之前使用\\\ @ 样式，如下例所示：

/// @file Sync.js
/// @namespace Sync
/// Module for loading and storing data

var Sync = {
    /// @function Sync.load
    /// Loads an resource
    /// @param {String} id the GUID of the resource
    /// @param {Function} success callback to be executed with the data on suceess
    /// @param {Function} error callback to be executed with error description in case of failure
    /// Loads an resource
    load : function (id, success, error) {
    },
}

之后，您可以像在项目的 Java 部分中一样运行 Doxygen 并生成 RTF