程序文档工具mp_doccer、xCHM、Doxygen、RDoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:mp_doccer(C代码文档制作)、xCHM(CHM文件查看器)、Doxygen(文档生成工具)、RDoc(Ruby自动文档工具)。

1、mp_doccer(C代码文档制作)

mp_doccer是用于传播C代码文件并提取带有特殊标记的信息的制作文档工具,该软件根据GPL许可发布。该文档可以HTML、手册页或可执行的Shell脚本生成。类似JavaDoc。

下载地址:https://triptico.com/software/mp_doccer.html

2、xCHM(CHM文件查看器)

程序文档工具mp_doccer、xCHM、Doxygen、RDoc介绍

xCHM 是跨平台的 CHM 文件查看器(已编译HTML帮助文件的查看器)。在文件支持的情况下,它可以显示目录树、打印当前页面以及支持书签。它支持改变字体以及全文或者标题搜索。xCHM 不支持书中的 JavaScript 脚本。

xCHM 主要特性包括:显示目录、打印页面、改变字体及大小、支持书签和搜索等等。

下载地址:https://packages.debian.org/unstable/x11/xchm

3、Doxygen(文档生成工具)

程序文档工具mp_doccer、xCHM、Doxygen、RDoc介绍

Doxygen 是一个 C++、C、Java、Objective-C、Python、IDL (CORBA 和 Microsoft flavors)、Fortran、VHDL、PHP、C#和D语言的文档生成器。可以运行在大多数类Unix系统,以及Mac OS X操作系统和Microsoft Windows。初始版本的Doxygen借鉴了一些老版本DOC++的代码。随后,Doxygen源代码由Dimitri van Heesch重写。

Doxygen是一个编写软件参考文档的工具。该文档是直接写在代码中,因此比较容易保持更新。Doxygen 可以交叉引用文档和代码,使文件的读者可以很容易地引用实际的代码。

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

4、RDoc(Ruby自动文档工具)

程序文档工具mp_doccer、xCHM、Doxygen、RDoc介绍

rdoc是Ruby自动生成文档的工具。rdoc生成的帮助文件是HTML格式的,rdoc提供“-f chm”命令参数生成chm文档。做成chm模式便于搜索。rdoc寻找的注释文档格式比较简单,主要搜索method、class、模块上紧接的注释行,rdoc Parser会搜索rb文件中每一处符合条件的注释,并且认为它们是用于生成文档的注释。

目前该项目已经集成到 Ruby 项目中,无需单独下载。

安装:

安装 rdoc 到你系统的全局,您需要在本地开发计算机上使用 Node >= 8。您可以使用 n 轻松切换不同项目之间的 Node 版本。

npm install rdoc -g

# /usr/local/bin/rdoc -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js

# /usr/local/bin/rdoc-cli -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js

增加了 rdoc-cli 命令来解决 Mac 集成 rdoc 命令冲突。

1]、初始化项目

rdoc init my-project  # Init project

# 或者

rdoc-cli init my-project 

2]、运行网站

cd my-project && npm install # 进入目录安装依赖

npm start # 启动服务。

3]、编译输出静态HTML资源

npm run build

4]、在 package.json 中配置部署 URL。

{

"scripts": {

"deploy": "rdoc --publish <your repo url>"

...

},

...

}

5]、部署到 Github gh-pages 分支

npm run deploy

开发:

获取代码,进入目录,运行自动重载构建:

$ git clone https://github.com/jaywcjlove/rdoc.git

$ cd rdoc     # 进入目录

$ npm install # or yarn install

要开发,请运行自重载构建:

# 运行应用程序

# 每次代码更改时,自动重新启动应用程序。

# 在开发过程中很有用。

$ npm run start

打开浏览器并访问 http://localhost:5858。

下载地址:https://gitee.com/jaywcjlove/rdoc

注明

以上就是程序文档工具mp_doccer、xCHM、Doxygen、RDoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章