去 1.5
在 Go 1.5 中,您可以使用新的go doc
子命令:
显示包或符号的文档
用法:
go doc [-u] [-c] [package|[package.]symbol[.method]]
Doc 打印与由其参数(包、常量、函数、类型、var 或方法)标识的项目相关联的文档注释,然后是该项目“下”的每个第一级项目的单行摘要(包包的级别声明、类型的方法等)。
[…]
当使用一个参数运行时,该参数被视为要记录的项目的类似 Go 语法的表示。参数选择的内容取决于安装在 GOROOT 和 GOPATH 中的内容,以及参数的形式,它示意性地是以下之一:
go doc <pkg>
go doc <sym>[.<method>]
go doc [<pkg>].<sym>[.<method>]
此列表中与参数匹配的第一项是打印其文档的项。(见下面的例子。)对于包,扫描的顺序是由词法确定的,但 GOROOT 树总是在 GOPATH 之前被扫描。
因此,对于您的示例,go doc url.URL
您无需知道该url
包是作为net/url
.
前去 1.5
在 Go 1.5 发布之前,您可以安装一个非常相似的命令:
go install robpike.io/cmd/doc
一旦安装你会做doc url.URL
。