程序文档工具Daux.io、Pasdoc、GTKMan、Flatdoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Daux.io(项目文档生成器)、Pasdoc(Pascal 代码文档工具)、GTKMan(man 手册页查看工具)、Flatdoc(程序文档生成工具)。

1、Daux.io(项目文档生成器)

程序文档工具Daux.io、Pasdoc、GTKMan、Flatdoc介绍

Daux.io是一个文档生成器,它使用简单的文件夹结构和Markdown文件来动态创建自定义文档。它以开发人员友好的方式帮助您创建美观的文档。

特征:

100%移动响应。

支持GitHub Flavored Markdown。

自动创建主页/登陆页。

自动语法提示。

自动生成导航。

4款内置主题并支持自定义主题。

功能、扁平化设计。

共享/可链接的SEO友好性URL。

基于Bootstrap构建。

无需设置步骤。

友好的Git/SVN。

Google Analytics。

可选的代码浮动布局。

安装及使用:

如果您已安装PHP和Composer:

composer global require daux/daux.io

#在您的“docs”文件夹旁边,运行

daux generate

或者如果您想使用Docker:

#在您的“docs”文件夹旁边,运行

docker run --rm -it -w /build -v "$PWD":/build daux/daux.io daux generate

下载地址:http://daux.io/

2、Pasdoc(Pascal 代码文档工具)

程序文档工具Daux.io、Pasdoc、GTKMan、Flatdoc介绍

Pasdoc为Pascal单位生成文档,它从源代码或外部文件中的注释中获取描述,文档输出格式包括HTML和LaTeX。支持对象Pascal、FreePascal和Delphi的特定功能。

特征:

理解以任何Pascal和Object Pascal方言编写的代码。

理解最新的FreePascal和Delphi版本中发现的现代Object Pascal语言。

许多输出格式:HTML,HTMLHelp,LaTeX(PDF,PS),latex2rft,XML。

命令行(批处理模式)和GUI界面。

来自源代码中的注释或单独文件中提供的文档。

任意(甚至可选)注释标记。

特殊的@标签用于格式化文档。

整个页面(如文档简介)可以使用@-tags编写。

使用Tipue在HTML输出中轻松搜索框。

类和单元依赖图。

可选的标识符自动链接。

拼写检查。

缓存,用于快速生成文档。

下载地址:https://sourceforge.net/projects/pasdoc/

3、GTKMan(man 手册页查看工具)

程序文档工具Daux.io、Pasdoc、GTKMan、Flatdoc介绍

GTKMan是一个简单的GTK+2手册页查看器,使用Python编写。通过指定手册页的名称和它们所在的部分来查看手册页,就像原始的man命令一样。手册页使用默认的系统等宽字体以简单文本形式显示。

4、Flatdoc(程序文档生成工具)

Flatdoc是一个小的JavaScript文件,可读取Markdown文件并将其呈现为整页。本质上,这是从自述文件制作开源文档的最简单方法。

特点:

没有服务器端组件。

无需构建过程。

可通过GitHub Pages进行部署。

可以获取GitHub自述文件。

华丽的默认主题(响应式)。

只需创建一个HTML文件并进行部署即可。

下载地址:http://ricostacruz.com/flatdoc/

注明

以上就是程序文档工具Daux.io、Pasdoc、GTKMan、Flatdoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章