godoc与go doc相关

最新推荐文章于 2024-09-26 11:01:02 发布

纯种哈士奇

最新推荐文章于 2024-09-26 11:01:02 发布

阅读量236

点赞数 1

分类专栏：服务计算文章标签： go linux

本文链接：https://blog.youkuaiyun.com/nonoli287/article/details/108965929

版权

服务计算专栏收录该内容

8 篇文章

订阅专栏

本文介绍了Go语言的godoc工具，它是一个用于生成和查看Go包文档的命令行工具。godoc可以在本地以网页形式展示代码文档，便于离线查阅。文章详细讲解了godoc的安装、使用方法，包括如何启动网页端、查看特定包的文档以及使用一些实用参数，如查看示例代码。godoc对于开发者来说，是一个便捷的代码文档管理工具。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

godoc与go doc相关

文章目录

godoc与go doc相关

环境

操作系统：Ubuntu18.04.5LTS-amd64

Why godoc & go doc

课程学习中只涉及文档与源代码中查询包，实际上godoc是一个方便的可以离线运行的命令，且以网页的方式展示生成的代码文档，在许多场景下使用更方便；

安装

运行godoc可能会显示无该命令，可以通过指令进行安装；

sudo apt install golang-golang-x-tools

如果有网络问题，同样可以通过github来曲线安装，至于具体的操作方式，可以类比go语言开发环境安装;

命令使用

godoc

网页端使用：

$ godoc -http=:6060

godoc会监听6060端口，通过浏览器访问http://127.0.0.1:6060，godoc基于GOROOT和GOPATH路径下的代码生成文档的。
打开链接，会发现直接进入了离线版的“不存在”的😂https://golang.org

godoc进入的：

https://golang.org网址直接进入的：

终端中使用：

$ godoc fmt Println

如果需要查看命令参数：

$ godoc -help

实用的参数：

-ex 查看示例代码

$ godoc -ex net/http FileServer

效果

...
Example:
    // Simple static webserver:
    log.Fatal(http.ListenAndServe(":8080", http.FileServer(http.Dir("/usr/share/doc"))))
...

go doc

go doc命令可以打印附于Go语言程序实体上的文档。

help获取帮助

go help doc

-cmd 打印出main包中的可导出的程序实体（其名称的首字母大写）的文档。

-u 打印出不可导出的程序实体（其名称的首字母小写）的文档。

go doc -u exec cmd

输出较多，只截取一部分：

作为对比，如果没有-u参数：

总结

事实上，两个命令还有大量功能，但受限于刚刚接触go这门语言，对其的了解和使用都比较粗浅，所以主要整理了实用性较高的几个命令，帮助查阅文档。