在golang中，可以使用godoc工具来提取注释内容。godoc工具会从Go程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档，也可以作为一个提供在线文档浏览的web服务器。

本教程操作环境：windows10系统、GO 1.18版本、Dell G3电脑。

在golang中，可以使用godoc工具来提取注释内容。

godoc工具

godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释，并生成相关文档，也可以作为一个提供在线文档浏览的 web 服务器，Go语言官网（https://golang.google.cn/）就是通过这种形式实现的。

go get


go get golang.org/x/tools/cmd/godoc


登录后复制

由于防火墙的原因，国内的用户可能无法通过go get 命令来获取 godoc 工具，这时候就需要大家来手动操作了。

  • 首先从 GitHub（https://github.com/golang/tools.git） 下载 golang.org/x/tools 包；

  • 然后将下载得到的文件解压到 GOPATH 下的 src\golang.org\x\tools 目录中，没有的话可以手动创建；

  • 打开 GOPATH 下的 src\golang.org\x\tools\cmd\godoc 目录，在该目录下打开命令行工具，并执行go build 命令，生成 godoc.exe 可执行文件；

  • 最后，将生成的 godoc.exe 文件移动到 GOPATH 下的 bin 目录中。（需要把 GOPATH 下的 bin 目录添加到环境变量 Path 中）

完成上述操作后就可以使用 godoc 工具了，godoc 工具一般有以下几种用法：

go doc packagego doc fmtgo doc package/subpackagego doc container/listgo doc package functiongo doc fmt Printffmt.Printf()

godoc 工具还可以获取 Go 安装目录下 ../go/src 中的注释内容，并将这些注释内容整合到 web 服务器中供我们预览。在命令行输入godoc -http=:6060，然后使用浏览器打开 http://localhost:6060 后，就可以看到本地文档浏览服务器提供的页面。

godoc的使用

在终端查看

go doc

这里查看的是包名的文档，以及所有的函数名字跟变量类型名



example: go doc terminal show: package test // import "test/testdoc" 这个是a.go的包名的描述 At 20191017 by Baiyu ---a.go end--- 这个是在doc.go 文件中的内容 在Go的源代码中 在Mac系统中 在类Unix系统中 在Windows系统中 ---doc.go end--- 这个是在testgodoc.go文件的内容 package Name: test describe: 程序的入口 ---testgodoc.go end--- 这个是z.go 的包名描述 ---z.go end--- const Email ... const Baiyu = "baiyu" func H(h1 string, h2 string) (reValue string) func Test(param1 string, inter int) (k string) func Z() type Computer struct{ ... } type Person struct{ ... } BUG: 这个注释会生成在文档最后后面，同时因为紧跟着fun Z，所以在上面的func列表里面也有显示 功能: 生成Z签名 BUG: 因为前面有BUG(who)这个关键字，所以这句注释就算没有紧跟关键字不会被隐藏掉 BUG: BUG(6):格式正确，所以这句注释就算没有紧跟关键字不会被隐藏掉，前面的BUG():、BUG6:、BUG:都是不正确的BUG(who)命名


登录后复制


go doc .


example: go doc test.Test terminal show: package test // import "test/testdoc" func Test(param1 string, inter int) (k string) 功能: 测试函数 参 数: param1 : 说明参数值 inter : 运算的数字 返回值: k : 返回值


登录后复制


go doc -src .


example: go doc -src test.Test terminal show: package test // import "test/testdoc" // 功能: 测试函数 // 参 数: // param1 : 说明参数值 // inter : 运算的数字 // 返回值: // k : 返回值 func Test(param1 string, inter int) (k string) { fmt.Println("测试函数") return param1 }


登录后复制

在浏览器上查看

godoc -http=:6060
localhost:6060/pkg127.0.0.1:6060/pkg
localhost:6060/pkg//127.0.0.1:6060/pkg//

导出godoc文档为HTML

godoc -url "http://localhost:6060/pkg///" > .html

导出来的是纯html文件，没有样式表，不过也有可能可以导出，但是我目前没有找到，如果有找到的朋友也可以交流一下

不过我也有把对应的样式文件给导出来了

下载地址https://github.com/BaiYu96/golandLearn/tree/master/learn_doc/stylefile

然后把html文件里面的css跟js指定的路径修改好就可以