godoc与go doc相关

    科技2025-11-29  23

    godoc与go doc相关

    文章目录

    godoc与go doc相关环境Why godoc & go doc安装命令使用godocgo 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这门语言,对其的了解和使用都比较粗浅,所以主要整理了实用性较高的几个命令,帮助查阅文档。

    Processed: 0.014, SQL: 10