问如何从Javascript生成RTF格式的文档

EN

您可以使用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) {
    },
}

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