go doc 笔记

1. go doc 笔记

为我们提供了快速生成文档以及查看文档的工具, 让我们可以很容易的编写查看文档

1.1. 使用 go doc 命令在终端查看

• 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() 的使用说明。

注意:

查看自定义的也是使用这些命令:

1. 必须配置 GOPATH
2. 自定义的 package 必须 src 下

1.2. 使用浏览器查看的方式

通过 godoc 命令可以在本机启动一个 web 服务, 我们可以通过打开浏览器, 访问这个服务来查看我们的 Go 文档。

godoc -http=<域名>:<端口号>

比如 godoc -http=localhost:8080。然后在浏览器中打开 127.0.0.1:8080, 你将会看到一个 golang.org 的本地副本, 通过它可查询 pkg 文档等其他内容。

关闭 web 服务关闭黑窗口，查看 package: localhost:8080/pkg/