目录
  • go doc
    • 一、使用go doc命令在终端查看
      • go doc package
      • go doc package/subpackage
      • go doc package function
    • 二、使用浏览器查看的方式

    Go语言基础go doc命令用法及示例详解

    go doc

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

    一、使用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下

    二、使用浏览器查看的方式

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

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

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

    查看package:
    localhost:8080/pkg/

    以上就是Go语言基础go doc命令的用法及示例详解的详细内容,更多关于Go语言基础命令的资料请关注其它相关文章!

    声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。