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

如何从Javascript生成RTF文档

1 个答案: