golang如何获取注释内容
这篇文章主要介绍“golang如何获取注释内容”的相关知识,小编通过实际案例向大家展示操作过程,操作方法简单快捷,实用性强,希望这篇“golang如何获取注释内容”文章能帮助大家解决问题。
创新互联专业为企业提供万柏林网站建设、万柏林做网站、万柏林网站设计、万柏林网站制作等企业网站建设、网页设计与制作、万柏林企业网站模板建站服务,10年万柏林做网站经验,不只是建网站,更提供有价值的思路和整体网络服务。
在golang中,可以使用godoc工具来提取注释内容。godoc工具会从Go程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的web服务器。
在golang中,可以使用godoc工具来提取注释内容。
godoc工具
godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的 web 服务器,Go语言官网(https://golang.google.cn/)就是通过这种形式实现的。
需要注意:Go语言 1.13 版本移除了 godoc 工具,大家可以通过go get
命令来获取 godoc 工具。
go get golang.org/x/tools/cmd/godoc
由于防火墙的原因,国内的用户可能无法通过go get 命令来获取 godoc 工具,这时候就需要大家来手动操作了。
首先从 GitHub下载 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 package
:获取包的文档注释,例如go doc fmt
会显示使用 godoc 生成的 fmt 包的文档注释;go doc package/subpackage
:获取子包的文档注释,例如go doc container/list
;go doc package function
:获取某个函数在某个包中的文档注释,例如go doc fmt Printf
会显示有关fmt.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(h2 string, h3 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
查看pkg包下面的func函数的注释
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
然后在打开浏览器的,在url输入localhost:6060/pkg
或者127.0.0.1:6060/pkg
就可以查看到你本地的所有包的信息了
如果你想要找到你特定的包名的话localhost:6060/pkg/
或者127.0.0.1:6060/pkg/
是你/src下包所在的路径
是包名
导出godoc文档为HTML
使用命令godoc -url "http://localhost:6060/pkg/
是你包所在的文件夹
是你的包名
关于“golang如何获取注释内容”的内容就介绍到这里了,感谢大家的阅读。如果想了解更多行业相关的知识,可以关注创新互联行业资讯频道,小编每天都会为大家更新不同的知识点。
文章标题:golang如何获取注释内容
当前路径:http://scyanting.com/article/posgoo.html