程序文档工具RubyMotion Tutorial、RManEdit、cldoc、Apache Commons Javadoc介绍

以下为你介绍的程序文档工具都可用在Linux系统上:RubyMotion Tutorial(包含 RubyMotion 开发工具的多个教程)、RManEdit(man 页面编辑器)、cldoc(C/C++ 代码文档生成器)、Apache Commons Javadoc(打包成一个 chm 文档)。

1、RubyMotion Tutorial(包含 RubyMotion 开发工具的多个教程)

RubyMotion-Tutorial 包含 RubyMotion 开发工具的多个教程。

2、RManEdit(man 页面编辑器)

程序文档工具RubyMotion Tutorial、RManEdit、cldoc、Apache Commons Javadoc介绍

程序文档工具RubyMotion Tutorial、RManEdit、cldoc、Apache Commons Javadoc介绍

RManEdit是一个图形化的Linux man页面编辑器,是带有Ruby和GTK的UNIX手册页编辑器。

安装:

您应该克隆存储库:

git clone https://github.com/COMU/RManEdit.git

基于Debian系统的要求:

sudo apt-get install ruby1.9.1-dev ruby-gtk2 libmagic-dev libwebkitgtk-3.0-dev ruby-gettext man2html libghc-webkit-dev

sudo gem install gtk2

sudo gem install ruby-filemagic

sudo gem install -v 0.0.5 gtk-webkit-ruby

您可以使用以下命令完成安装:

gem build rmanedit.gemspec

sudo gem install RManEdit-2.0.2.gem

sudo chmod +x install 

./install

下载地址:http://comu.github.io/RManEdit/

3、cldoc(C/C++ 代码文档生成器)

cldoc 是一个使用 clang 实现的 C/C++ 代码文档生成器。cldoc试图通过一种现代的方法来解决编写C/C++软件文档的问题。

特点:

使用 clang 可靠解析大多数复杂的 C++ 项目。

零配置。

使用 markdown 做为文档格式。

生成描述 API 的 XML 文档。

使用简单格式用于文档化代码。

支持文档中的跨引用。

生成单个使用 JavaScript 的 Web 文件。

无缝集成已有网站。

轻量级快速的客户端搜索。

生成格式化的覆盖率报告文档。

使用pip安装:

cldoc在Python软件包索引中可用,到目前为止,这是安装cldoc的最简单方法,确保已安装pip(在ubuntu和fedora上安装python-pip),只需使用pip install --user cldoc(您可能需要在fedora上使用python-pip命令代替)。--user将在~/.local中本地安装cldoc。如果要在系统中全局安装它,请改用sudo pip install cldoc。

下载地址:http://jessevdk.github.io/cldoc/

4、Apache Commons Javadoc(打包成一个 chm 文档)

程序文档工具RubyMotion Tutorial、RManEdit、cldoc、Apache Commons Javadoc介绍

该项目将所有的 Apache Commons 中的项目里的 Javadoc 打包成了一个 chm 文档,使用非常方便。

注明

以上就是程序文档工具RubyMotion Tutorial、RManEdit、cldoc、Apache Commons Javadoc的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章