程序文档工具FileTransfer、APIdoc-Go、Springfox、DocFX介绍

以下为你介绍的程序文档工具都可用在Linux系统上:FileTransfer(多线程文件上传和下载工具)、APIdoc-Go(RESTful API 文档生成工具)、Springfox(开源的API doc框架)、DocFX(文档生成工具)。

1、FileTransfer(多线程文件上传和下载工具)

程序文档工具FileTransfer、APIdoc-Go、Springfox、DocFX介绍

注:以上为软件的截图。

FileTransfer是多线程文件上传和下载工具,支持FTP、Email、MSMQ、ActiveMQ等多种传输方式。

FileTansfer介绍:

FileTansfer是柒软科技倾力打造的一款简单易用的文件传输系统。

FileTansfer特性:

多线程任务模式,易扩展。

系统服务运行方式,重启无忧。

支持FTP、Email、MSMQ、ActiveMQ等多种常用传输方式,可扩展。

稳定、易用、开源。

下载地址:https://gitee.com/hahago/FileTransfer

2、APIdoc-Go(RESTful API 文档生成工具)

APIdoc是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生成文档。目前支持支持以下语言:C#、C/C++、Go、Java、Javascript、Perl、PHP、Python、Ruby、Rust 和 Swift。

使用:

在 https://github.com/caixw/apidoc/releases 提供了主流系统下可用软件,可直接下载使用。 如果你使用的系统不在此列,则需要手动下载编译。

支持多种本地化语言,默认情况下会根据当前系统所使用的语言进行调整。也可以通过设置环境变更 LANG 指定一个本地化信息。*nix 系统也可以使用以下命令:

LANG=lang apidoc

将其中的 lang 设置为你需要的语言。

集成:

若需要将 apidoc 当作包集成到其它 Go 程序中,可参考以下代码:

// 初始本地化内容

apidoc.Init(language.MustParse("zh-Hans"))

// 可以自定义实现具体的错误处理方式

h := message.NewHandler(...)

output := &output.Options{...}

inputs := []*input.Options{

&input.Options{},

}

apidoc.Build(h, output, inputs...)

下载地址:https://gitee.com/caixw/apidoc

3、Springfox(开源的API doc框架)

Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现。

pom依赖:

<!--springfox依赖-->

<dependency>

<groupId>com.mangofactory</groupId>

<artifactId>swagger-springmvc</artifactId>

<version>1.0.2</version>

</dependency>

<!--jackson依赖-->

<dependency>

<groupId>com.fasterxml.jackson.core</groupId>

<artifactId>jackson-databind</artifactId>

<version>2.4.2</version>

</dependency>

<!--静态页面依赖的webjar-->

<dependency>

<groupId>org.webjars.bower</groupId>

<artifactId>swagger-ui</artifactId>

<version>2.1.8-M1</version>

</dependency>

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

4、DocFX(文档生成工具)

微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文件链接到API添加额外的说明,DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站,你可以自己通过模版定制, 目前已经内嵌了几个模版,包括静态的HTML页面和AngularJS页面。你还可以自己定制模版。

注明

以上就是程序文档工具FileTransfer、APIdoc-Go、Springfox、DocFX的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章