程序文档工具Manumission、GTK-Doc、ChmFox、jchmweb介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Manumission(HTML帮助文件创建工具)、GTK-Doc(C语言文档生成工具)、ChmFox(Firefox的CHM浏览器扩展)、jchmweb(基于 Web 的 chm 浏览器)。

1、Manumission(HTML帮助文件创建工具)

程序文档工具Manumission、GTK-Doc、ChmFox、jchmweb介绍

Manumission 是一个命令行工具用来创建 HTML 帮助文件,所创建的文件可用 xchm\hh.exe 浏览,其目的是创建 Windows Help 兼容的帮助文件,无需配置。

2、GTK-Doc(C语言文档生成工具)

GTK-Doc 是一个用来从C代码的注释中生成API文档的工具,尤其适用于使用gobject对象机制编程的项目,并不局限于GTK+或GNOME相关library和程序的文档生成。

主要工作流程:

基本上,使用GTK-Doc生成API文档,包括几个步骤:

在项目相关目录和Build相关文件中添加 GTK-Doc所需参数和相关配置文件。

在代码中按照一定的格式规范添加注释(于普通的注释相比,只需要添加非常少的额外信息)。

使用标准的Build流程(autogen,configure,make等)编译并生成文档。

修改部分GTK-Doc生成的模板和配置文件,进行一些定制工作,如排除某些函数,定制布局,添加而外的help文档等(这部分工作并不需要每次都做,这些模板和配置文件只在第一次build的时候生成,以后不会自动覆盖)。

3、ChmFox(Firefox的CHM浏览器扩展)

ChmFox是Firefox的扩展程序,可为所有平台带来最佳的CHM文件读取体验。可以在Windows、Mac和Linux下使用此扩展名在Firefox中直接查看CHM文件。

用法:

下载并安装ChmFox

安装后,重新启动Firefox以使ChmFox正常工作。

通过菜单->文件->打开打开CHM文件。

您可以将firefox设置为打开CHM文件的默认程序,然后,只需双击CHM文件并享受ChmFox。

CHM文件内容/索引有一个侧边栏,您可以使用热键Ctrl+Alt+m(或在Mac下为Command+Option+m)将其打开/关闭。

重新打开CHM文件时,ChmFox会记住并跳至最后一个阅读位置,并且您可以始终使用Firefox的内置书签功能为任意数量的CHM页面添加书签

与普通网页一样,按Ctrl+/Ctrl-缩放页面,ChmFox会记住每个CHM文件的页面缩放级别。

设置开发环境:

首先找到个人档案目录,在Mac上,所有配置文件都在:

~/Library/Application Support/Firefox/Profiles/

然后选择一个特定的配置文件,您可以在中看到所有个人资料名称及其位置:

~/Library/Application Support/Firefox/Profiles/profiles.ini

接下来,在您选择的配置文件的扩展目录中添加一个文本文件chmfox@zhuoqiang.me,例如:

~/Library/Application Support/Firefox/Profiles/2al7gpp8.dev-edition-default/extensions/chmfox@zhuoqiang.me

在该文件中添加单行,这会将firefox指向本地chmfox源目录(以/结尾):

~/source/chmfox/

重新启动firefox,您已经安装了本地chmfox,源代码中的所有更改都将在不构建的情况下生效。

下载地址:https://bitbucket.org/zhuoqiang/chmfox/

4、jchmweb(基于 Web 的 chm 浏览器)

jchmweb 是一个基于 Web 的 chm 浏览器。

注明

以上就是程序文档工具Manumission、GTK-Doc、ChmFox、jchmweb的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章