程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet介绍

以下为你介绍的程序文档工具都可用在Linux系统上:documentr(软件文档编辑工具)、mysqldgtool(MySQL文档生成工具)、I/O Docs(交互式文档系统)、RESTdoclet(用于从基于Spring REST框架的服务中生成Web文档)。

1、documentr(软件文档编辑工具)

程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet介绍

documentr是一个基于web的工具,用于编辑和展示软件文档。它允许您轻松地维护文档为多个产品和产品分支。编辑可以很容易被复制分支之间,合并冲突被妥善处理。它使用 Markdown 作为其标记语言,以及一些扩展,并有一个基于角色的权限系统。

2、mysqldgtool(MySQL文档生成工具)

在开发中往往需要写文档,而数据库设计这部分又是必不可少的,自己写了一个针对mysql数据库的文档生成工具。

效果如下:

程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet介绍

Mysql文档生成工具:

-h:mysql的ip地址

-P: 端口

-u:用户名

-p:密码

-d:数据库名

-t:数据库表名

compile.bat 编译脚本

start.bat 启动脚本

版本V1.0.1把项目打成jar发布。

提供两个启动脚本:

start.bat windows下的启动脚本。

start.sh linux下的启动脚本。

程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet介绍

注意:用户名需要root权限,软件需要读取表columns。

3、I/O Docs(交互式文档系统)

I/O Docs 是一个用于 RESTful Web APIs 的交互式文档系统。使用 JSON 模型根据资源、方法和参数定义 APIs。I/O Docs 将生成 JavaScript 客户端接口,可通过这些接口来调用系统。服务器端基于 Node.js 开发。

4、RESTdoclet(用于从基于Spring REST框架的服务中生成Web文档)

程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet介绍

IG GROUP 已经开源了它的RESTdoclet Maven插件项目,该插件用于从基于Spring REST框架的服务中生成Web文档。

好处:

启用创建企业REST服务文档Web门户的功能,为服务使用者提供一个集中的呼叫端口。

支持从基础服务源代码自动生成文档,从而确保文档始终是最新的。

特征:

显示Spring注释的服务操作,类型和关联的Javadoc。

使用Javadoc对Spring 3 RESTful服务进行开箱即用的支持。

Java 5/6支持,还有Java 7等。

可定制的交互式Web文档应用程序。

与Maven构建过程轻松集成。

无需自定义注释-开箱即用支持Spring 3 REST注释。

RESTdoclet Wiki上的更多详细信息。

下载地址:http://ig-group.github.io/RESTdoclet/

注明

以上就是程序文档工具documentr、mysqldgtool、I/O Docs、RESTdoclet的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章