程序文档工具Pootle、YUI Doc、JsDoc Toolkit、Sphinx文档工具介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Pootle(翻译管理工具)、YUI Doc(JavaScript API文档生成工具)、JsDoc Toolkit(在 JavaScript 代码中添加相应的注释)、Sphinx文档工具(文档生成工具)。

1、Pootle(翻译管理工具)

Pootle 是一个基于Web的翻译和翻译管理工具。它提供了mangaging翻译项目一组丰富的功能。它集成的翻译工具包组件检查器提供错误信息和翻译在不同格式的能力。Pootle还可以提供下载编译PO文件。你可以使用它来指定你的团队中工作,翻译,您可以定义目标,以帮助你的翻译重点的努力。Pootle的允许可以无需Web服务器,或通过现有的Apache服务器代理。

Pootle是服务器:

Pootle是使用Django框架以Python编写的,因此可以安装在支持服务WSGI应用程序的任何Web服务器上。Pootle可以托管多种语言的翻译项目。团队可以管理其文件,权限,项目以及在线翻译。可以下载文件以进行离线翻译。

特点:

多种文件格式:

支持关键的本地化文件格式,包括Gettext PO,XLIFF,Java .properties,PHP数组,以及Translate Toolkit支持的更多格式。

注重质量:

通过自动检测翻译人员的常见错误来确保最佳质量的本地化。

强大的在线编辑器:

集成用户建议,术语,翻译记忆库,机器翻译等。

Pootle 2.8.2版本主要变化:

修复了没有git命令的部署。

更新了UI语言发现,以在尝试回退之前尝试使用更简单的语言代码。

更新了文档。

安装命令:

pip install --pre Pootle

下载地址:https://gitee.com/mirrors/pootle

2、YUI Doc(JavaScript API文档生成工具)

YUIDoc 是一个基于 Node.js 的应用程序,用来根据 JavaScript 的注释中生成 API 文档,类似 JavaDoc,这也是当前 YUI 用来生成文档的工具。

生成的文档效果:

程序文档工具Pootle、YUI Doc、JsDoc Toolkit、Sphinx文档工具介绍

示例语法:

/**

* My method description.  Like other pieces of your comment blocks, 

* this can span multiple lines.

*

* @method methodName

* @param {String} foo Argument 1

* @param {Object} config A config object

* @param {String} config.name The name on the config object

* @param {Function} config.callback A callback function on the config object

* @param {Boolean} [extra=false] Do extra, optional work

* @return {Boolean} Returns true on success

*/

YUIDoc 提供:

即时预览。

流行的标注。

支持多种语言。

其他特性:

注释支持 Markdown 语法。

开箱即用支持更多标签。

逻辑分开,易于扩展。

更好的主题支持。

用于开发时间预览的服务器模式。

外部数据混合。

易于跨平台安装。

在当前项目内部和外部进行交叉链接。

基于JSON的配置。

3、JsDoc Toolkit(在 JavaScript 代码中添加相应的注释)

JsDoc Toolkit 是一款辅助工具,你只需要根据约定在 JavaScript 代码中添加相应的注释,它就可以根据这些注释来自动生成API文档。对Java 熟悉的人可能会发现它和 Java 的文档自动化工具 JavaDoc 很像,其实 JsDoc Toolkit 就是基于 JavaDoc 开发的。

4、Sphinx文档工具(文档生成工具)

程序文档工具Pootle、YUI Doc、JsDoc Toolkit、Sphinx文档工具介绍

Sphinx简单来说,是一个文档生成工具,用于把reStructuredText 格式的源文件生成诸如HTML、PDF、LaTex一类的格式。编辑者无须亲自处理文本的格式,程序会自动根据源文件里的设置产生格式,以及自动生成章节链接等工作。

和 DocBook一样,Sphinx可以看做是一个把文本格式处理和文字编辑分开的工具。举个例子来说吧,大家一定都曾有过上学时用Word痛苦地修改论文的经验(没办法,在中国LaTex太小众),其中Word里面千奇百怪的可见或不可见的格式符、控制符一定玩弄了大家很久。而类似DocBook或 reStructuredText 一类的格式则完全采用文本文件来记录文字格式,各种格式控制字符完全可见,不会出现如Word里某个隐藏在段落末尾的莫名控制符导致文章之后的某些部分完全乱掉,而完全找不到这个控制符的情况了。同时,完全采用纯文本文件进行记录,使得使用版本控制软件对编辑工作进行全程追踪和记录成为了可能。而最终通过文本的源文件生成具有格式和样式的文本则完全是程序所进行的工作,避免了一切出错的可能。

使用Sphinx的项目有很多,著名的包括 Python、Django 的文档,全部是使用Sphinx 生成的。

程序文档工具Pootle、YUI Doc、JsDoc Toolkit、Sphinx文档工具介绍

功能包括:

输出格式:HTML(包括派生格式,例如HTML帮助,Epub和Qt帮助),纯文本,手册页和LaTeX或使用rst2pdf的直接PDF输出。

广泛的交叉引用:功能,类,词汇术语和类似信息的语义标记和自动链接。

层次结构:轻松定义文档树。

自动索引:常规索引以及模块索引。

代码处理:使用Pygments荧光笔自动突出显示。

使用Jinja 2模板引擎灵活的HTML输出。

提供各种扩展名,例如用于自动测试代码片段并包含适当格式的文档字符串。

Setuptools集成。

安装:

Sphinx在PyPI上发布,可以从那里安装:

pip install -U sphinx

我们还将发布Beta版本,安装命令是:

pip install -U --pre sphinx

下载地址:https://gitee.com/mirrors/sphinx-doc

注明

以上就是程序文档工具Pootle、YUI Doc、JsDoc Toolkit、Sphinx文档工具的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章