Golang 见证 godoc 的强大（生成API文档，打印文档）

文章目录

Golang 见证 godoc 的强大（生成API文档，打印文档）
- 一、godoc 介绍
- 二、godoc 安装
- - ① 系统环境
  - ② 下载安装
- 三、godoc 使用
- 四、godoc 的其他功能

本次我们使用的是 godoc 来生成 API 文档

一、godoc 介绍

在辛苦写完一个项目后，你是否苦恼于不知怎么给用户解释它的功能，又或者是觉得一一解释太过繁琐？不怕，接下来笔者要介绍的 godoc 就是一项有力的自动生成 API 工具，既方便了读者，又帮助了开发者
godoc 是 Go 语言中一个可以自动生成 API 文档的第三方库

二、godoc 安装

① 系统环境

操作系统：CentOS Linux release 7.9.2009
代码编辑器：visual studio code
编译工具：go version go1.13.1 linux/amd64

② 下载安装

git clone https://github.com/golang/tools $GOPATH/src/golang.org/x/tools
go build golang.org/x/tools

然后在命令行中就可以正常执行 godoc 命令
或者也可以直接使用指令 go get -v golang.org/x/tools/cmd/godoc 一步到位

三、godoc 使用

下文将以笔者开发的 json_Marshal 项目为例，演示如何用 godoc 生成 API 文档

首先注释项目 iniReader main.go 文件的 main 函数，将 package 改为iniReader，然后执行如下指令:

go install
// 生成 API 文档
godoc
// 下载保存 API 文档
godoc -url="pkg/jsonmarshal/jsonmarshal" > API.html

便会在当前目录下生成 API.html 文件:

API 文档，用浏览器打开后界面如下

可以保存为 PDF 文件
或者也可以通过网络浏览器的地址栏中输入 http://localhost:8080/pkg/jsonmarshal/jsonmarshal 来查看以网页方式展现的 API 文档

四、godoc 的其他功能

godoc 还有另一种功能就是打印纯文本格式的文档到标准输出
比如我们用命令行模式查看代码包 log 的文档，如下图，包括了 log 的介绍，和所有函数

go doc log

如果我们想查看某一个函数或结构体的文档，可以将这个函数或结构体的名称加入命令的后面，即

go doc log Fatal

或者

go doc log Logger

此外，还可以通过添加 -src 查看它们的源码

go doc -src log Fatal

以上就是 godoc 强大之处的介绍

Golang 见证 godoc 的强大（生成API文档，打印文档）相关推荐

使用sphinx快速为你python注释生成API（html）文档
sphinx简介 sphinx是一种基于Python的文档工具,它可以令人轻松的撰写出清晰且优美的文档,由Georg Brandl在BSD许可证下开发.新版的Python3文档就是由sphinx生成的 ...
godoc安装与自动生成API文档
先使用命令go get golang.org/x/tools/cmd/godoc来安装godoc.该命令会访问官网下载godoc,有可能访问超时.为此,需要在Bash下设置如下的环境变量: expor ...
api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...
这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...
springboot 集成 swagger 自动生成API文档
Swagger是一个规范和完整的框架,用于生成.描述.调用和可视化RESTful风格的Web服务.简单来说,Swagger是一个功能强大的接口管理工具,并且提供了多种编程语言的前后端分离解决方案. S ...
.NET Core 3.0 使用Nswag生成Api文档和客户端代码
摘要在前后端分离.Restful API盛行的年代,完美的接口文档,成了交流的纽带.在项目中引入Swagger (也称为OpenAPI),是种不错的选择,它可以让接口数据可视化.下文将会演示利用N ...
knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案
knife4j knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui,取名kni4j是希望它能像一把匕首一样小巧,轻量, ...
【接口文档】Django restful framework中自动生成API文档
Django restful framework中自动生成API文档一.Swagger概述 1.引言当接口开发完成,紧接着需要编写接口文档.传统的接口文档使用Word编写,or一些接口文档管理平台 ...
干掉 Swagger + Postman？测试接口直接生成API文档，这个国产文档工具真香！
点击上方"芋道源码",选择"设为星标" 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏原创 | ...
一款强大的API接口文档管理工具（Smart-Doc + Torna）
[本文由龙飞同学供稿] 在团队协作开发项目的时候,接口文档承担着向其他开发人员说明接口相关信息的重要任务,因此,一份清晰而又相近的接口文档至关重要. 但是,写接口文档的痛苦想必各位开发人员都体验过,明 ...

Golang 见证 godoc 的强大（生成API文档，打印文档）

Golang 见证 godoc 的强大（生成API文档，打印文档）

文章目录

一、godoc 介绍

二、godoc 安装

① 系统环境

② 下载安装

三、godoc 使用

四、godoc 的其他功能

Golang 见证 godoc 的强大（生成API文档，打印文档）相关推荐

最新文章

热门文章