0

我仍在努力以一种快速理解的方式来表达这个问题,所以我将记录我遇到的问题所遵循的步骤。

  1. 我正在查找 net/http 包中 Request 结构的文档。我这样做是通过godoc net/http Request
  2. 现在浏览文档,请求结构的第一个字段是 URL,它是*url.URL我想查找其文档的类型。
  3. 但是 godoc 没有详细说明它属于哪个导入路径。我只知道包名称本身是“url”,但它的规范导入路径类似于“some/path/url”,我想知道这样我就可以查找它并找出 URL 字段。

我要遵循哪些步骤来获取url上述文档中引用的特定包?

4

2 回答 2

2

去 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

于 2015-07-27T16:22:35.733 回答
1

您可以使用以下命令运行查询godoc

$ godoc -q URL | less
QUERY
        URL

DID YOU MEAN

        url

Types
    net/url.URL
    html/template.URL
...
...
...

Types 中的 net/url 是一个不错的选择。

$ godoc net/url | less
PACKAGE DOCUMENTATION

package url
    import "net/url"

    Package url parses URLs and implements query escaping. See RFC 3986.

FUNCTIONS
...
...
...
于 2015-07-27T08:58:29.033 回答