程序文档工具doxmate、Rocco、Pycco、Dash.py介绍

以下为你介绍的程序文档工具都可用在Linux系统上:doxmate(API文档工具)、Rocco(Ruby 语言移植版本)、Pycco(Docco的Python移植版本)、Dash.py(一键给 Dash 安装 Python 文档)。

1、doxmate(API文档工具)

过去通常要自己维护API文档,这会是一件比较蛋疼的事情。所幸我们有dox,dox可以帮我们解析注解。但是dox不能帮我们任意生成文档。于是就有了doxmate,doxmate基于dox的注解对象,加入模板。在遵循Github和CommonJS的约定后,doxmate可以帮你的模块包快速生成文档。

提供两种风格文档:

程序文档工具doxmate、Rocco、Pycco、Dash.py介绍

程序文档工具doxmate、Rocco、Pycco、Dash.py介绍

2、Rocco(Ruby 语言移植版本)

Rocco 是快速而又文盲的编程风格文档。

Rocco 是 Docco 的 Ruby 语言移植版本。

Rocco读取Ruby源文件并以HTML格式生成带注释的源文档。注释使用Markdown格式化,并与语法突出显示的代码一起显示,以提供注释效果。

其中大部分内容是在等待node.js构建时编写的,Docco的华丽HTML和CSS被逐字记录。主要区别在于Rocco是用Ruby而不是CoffeeScript编写的,并且在现有Ruby环境中或尚未运行节点的环境中获取和安装起来可能会更容易一些。

使用Rubygems安装Rocco:

gem install rocco

安装完成后,可以使用rocco命令生成一组Ruby源文件的文档:

rocco lib/*.rb

HTML文件将写入当前工作目录。

下载地址:https://gitee.com/mirrors/rocco

3、Pycco(Docco的Python移植版本)

程序文档工具doxmate、Rocco、Pycco、Dash.py介绍

Pycco 是 Docco 的 Python 移植版本。

它生成HTML,该HTML在代码旁边显示您的注释。注释通过Markdown和SmartyPants1传递,而代码通过Pygments传递以突出显示语法。

如果安装Pycco,则可以从命令行运行它:

pycco src/*.py

这将为命名的源文件生成链接的HTML文档,默认情况下将其保存到docs文件夹中。

Pycco的源代码可在GitHub上获得,并根据MIT许可发布。

要安装Pycco,只需:

pip install pycco

或者:

git clone git://github.com/pycco-docs/pycco.git

cd pycco

python setup.py install

下载地址:https://gitee.com/mirrors/pycco

4、Dash.py(一键给 Dash 安装 Python 文档)

Dash.py 可以让你一键给 Dash 安装 Python 文档。

安装:

pip install dash.py

使用方法:

dash.py install flask jinja2 sqlalchemy

注明

以上就是程序文档工具doxmate、Rocco、Pycco、Dash.py的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章