为我们提供了快速生成文档以及查看文档的工具,让我们可以很容易的编写查看文档
获取包的文档注释
例如:
go doc fmt 会显示使用 godoc 生成的 fmt 包的文档注释。
获取子包的文档注释
例如:
go doc container/list
获取某个函数在某个包中的文档注释
例如:
go doc fmt Printf 会显示有关 fmt.Printf() 的使用说明。
注意:
查看自定义的也是使用这些命令:
通过godoc命令可以在本机启动一个web服务,我们可以通过打开浏览器,访问这个服务来查看我们的Go文档。
godoc -http=<域名>:<端口号>
比如godoc -http=localhost:8080。然后在浏览器中打开127.0.0.1:8080,你将会看到一个golang.org的本地副本,通过它可查询pkg文档等其他内容。关闭web服务关闭黑窗口
查看package:
localhost:8080/pkg/