Go语言中go doc命令用法及示例分析

    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/

    原创文章,作者:OFEVW,如若转载,请注明出处:https://www.beidanyezhu.com/a/29374.html

    (0)
    OFEVW的头像OFEVW
    上一篇 2025-02-07
    下一篇 2025-01-07

    相关推荐

    发表回复

    您的邮箱地址不会被公开。 必填项已用 * 标注

    分享本页
    返回顶部