adoc-自动生成的api文档工具

adoc

adoc是一个文档生成工具，根据golang代码注释，生成README格式的API文档，只能识别特定的API注释语法。

在前后端分离的开发模式下，后台人员往往要提供一个接口文档给前端人员。 虽然已经有了一些开源工具，可以根据注释生成文档，但这些工具往往都很臃肿，很难根据自己的实际开发体验去做定制。

安装adoc

首先我们需要在GOPATH上从该软件作者的github进行git clone

git clone https://github.com/day-dreams/adoc.git

然后cd到对应目录下,进行make

假如没有安装make，则使用apt install 安装make后使用

sudo apt install make

我们发现他提示我们找不到api包，我们进入api文件夹，更改其中的import选项即可

然后再度进行make

按照提示，进行go build

然后进行make install

按照提示，进行copy命令（这里要管理员权限，所以要sudo）

最后再使用他自带的测试文件进行测试，则发现所需要的api文档内容已输入到控制台。

如果需要生成文件，则可以将fmt的标准输出重定向到指定文件即可。