欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

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

程序员文章站 2022-04-06 20:32:52
目录go doc一、使用go doc命令在终端查看go doc packagego doc package/subpackagego 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语言基础命令的资料请关注其它相关文章!