程序文档工具GCFM、InkpadDoxygen、txt2tags、flydoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:GCFM(通用配置形式管理器)、InkpadDoxygen(Inkpad文档生成工具)、txt2tags(文档生成器)、flydoc(文档自动生成工具)。

1、GCFM(通用配置形式管理器)

程序文档工具GCFM、InkpadDoxygen、txt2tags、flydoc介绍

Generic Configuration Form Manager (GCFM, a.k.a. webconfig) 是极其简单的 Web 服务器,提供 Web 服务来更新配置文件。提供一个 Web 服务骨干作为示例,用来开发特定的配置文件编辑器。

General Configuration Form Manager-通用配置表单管理器是一种简约的Web服务器,它提供一些Web服务来更新配置文件。目录skel中提供了一个Web服务框架,作为开发特定配置文件编辑器的示例。大多数情况下,需要在script.inc.js文件中自定义帮助选项卡消息和导入/导出功能。

此外,GCFM还提供了一种配置极简Web服务器的表单,以启用配置编辑器服务。它允许:

从服务器加载Web服务器配置文件。

将修改后的Web服务器配置文件保存到服务器。

从本地文件系统导入Web服务器配置文件。

将修改后的配置导出到本地文件系统。

很明显,更改已安装的配置文件编辑器的别名,目录名,配置文件名和服务描述。

要求:

GCFM只需要python,它已经在Linux的python 2.7上进行了测试。

安装:

要安装,只需要将归档文件解压缩到可访问的目录中,服务器用户的alias.csv文件必须是可写的,使用命令./webconfig在8042端口上启动Web服务器。

下载地址:http://www.softndesign.org/codes/python/webconfig/

2、InkpadDoxygen(Inkpad文档生成工具)

程序文档工具GCFM、InkpadDoxygen、txt2tags、flydoc介绍

为矢量绘图软件Inkpad自动生成漂亮清晰的UML图、文件依赖关系图。

目前是在Mac OS X下使用Doxygen自动生成文档,通过脚本优化文件关系。Windows下设置Doxygen和GraphViz的安装位置后也可生成文档。本项目做少量改动后可为其他项目生成文档。

3、txt2tags(文档生成器)

Txt2tags 是一个文档生成器。他将指定的标记(如:**粗体**和//斜体//)转换为下列格式:

HTML、XHTML、SGML、DocBook、LaTeX、Lout、Man page、Creole、Wikipedia/MediaWiki、Google Code Wiki、PmWiki、DokuWiki、MoinMoin、MagicPoint、PageMaker、AsciiDoc、ASCII Art、Plain text、以及你喜欢的格式。

说明:

Txt2tags是Python脚本,因此您必须安装Python才能运行它。

您只能下载txt2tags.py脚本本身,该脚本是自包含的,没有任何外部依赖性,或者您可以下载还包含文档、工具和示例的软件包(tarball或Zip)。

下载地址:https://txt2tags.org/

4、flydoc(文档自动生成工具)

flydoc是一款根据markdown自动生成文档的工具。支持多层级文件夹,代码高亮,多模板。

flydoc是纯绿色软件,在Windows可以直接执行flydoc.exe运行。

注明

以上就是程序文档工具GCFM、InkpadDoxygen、txt2tags、flydoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章