当开发人员需要了解包的一些情况时,可以使用 godoc 来显示包的文档说明,下面来介绍一下 godoc 工具的使用。

godoc 工具

godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的 web 服务器,Go语言官网(https://golang.google.cn/)就是通过这种形式实现的。

 

但是Go语言 1.13 版本移除了 godoc 工具,大家可以通过go get命令来获取 godoc 工具。

go get golang.org/x/tools/cmd/godoc

由于防火墙的原因,国内的用户可能无法通过go get 命令来获取 godoc 工具,这时候就需要大家来手动操作了。

  • 首先从 GitHub(https://github.com/golang/tools.git) 下载 golang.org/x/tools 包;

  • 然后将下载得到的文件解压到     GOPATH 下的 src\golang.org\x\tools 目录中,没有的话可以手动创建;

  • 打开 GOPATH 下的 src\golang.org\x\tools\cmd\godoc 目录,在该目录下打开命令行工具,并执行go build 命令,生成 godoc.exe 可执行文件;

  • 最后,将生成的 godoc.exe 文件移动到 GOPATH 下的 bin 目录中。(需要把 GOPATH 下的 bin 目录添加到环境变量 Path 中)

完成上述操作后就可以使用 godoc 工具了,godoc 工具一般有以下几种用法:

  • go doc package:获取包的文档注释,例如go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释;

  • go doc package/subpackage:获取子包的文档注释,例如go doc container/list;

  • go doc package function:获取某个函数在某个包中的文档注释,例如go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。

 

 

 

 

 

godoc 工具还可以获取 Go 安装目录下 ../go/src 中的注释内容,并将这些注释内容整合到 web 服务器中供我们预览。在命令行输入godoc -http=:6060,然后使用浏览器打开 http://localhost:6060 后,就可以看到本地文档浏览服务器提供的页面。

 

 

 

 

# 查看包内的文档,这里是查看 fmt 包中 Printf Println 的的文档
godoc fmt Printf Println
# 查看文档并包含源码
godoc -src fmt Printf
# 查看的同时显示示例代码
godoc -ex fmt Printf
# 显示文档的web版本 http -> 端口
godoc -http=:6060
# 显示 http 文档并开启本地索引
godoc -http=:6060 -index