首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >如何从Javascript生成RTF格式的文档

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

Stack Overflow用户
提问于 2018-05-30 03:58:27
回答 1查看 1.1K关注 0票数 3

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

Javascript文件是JSDoc注释的,但我可以很容易地将其更改为其他格式。

我知道JSDoc、ESDoc和YUIDoc。它们都生成超文本标记语言,尽管不是所有的都能很好地工作,例如,由于文件名问题,YUIDoc跳过了很多文件。它们似乎都不处理CSS文件(或HTML)。

我也知道pandocs。我认为可以使用JSDoc或ESDoc来生成超文本标记语言,然后通过Pandoc将它们转换为RTF格式,但目前还没有做到这一点。

还有其他的解决方案吗?有人已经这么做了吗?

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

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2018-05-31 01:15:46

您可以使用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筛选器在函数和命名空间之前使用\\\ @样式,如下例所示:

代码语言:javascript
复制
/// @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部分中一样

票数 3
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/50592045

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档