golang如何获取注释内容
导读:本文共3167.5字符,通常情况下阅读需要11分钟。同时您也可以点击右侧朗读,来听本文内容。按键盘←(左) →(右) 方向键可以翻页。
摘要: 在golang中,可以使用godoc工具来提取注释内容。godoc工具会从Go程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的web服务器。在golang中,可以使用godoc工具来提取注释... ...
目录
(为您整理了一些要点),点击可以直达。
在golang中,可以使用godoc工具来提取注释内容。godoc工具会从Go程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的web服务器。
在golang中,可以使用godoc工具来提取注释内容。
godoc工具
godoc 工具会从 Go 程序和包文件中提取顶级声明的首行注释以及每个对象的相关注释,并生成相关文档,也可以作为一个提供在线文档浏览的 web 服务器,Go语言官网(https://golang.google.cn/)就是通过这种形式实现的。
需要注意:Go语言 1.13 版本移除了 godoc 工具,大家可以通过go get
命令来获取 godoc 工具。
gogetgolang.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:godocterminalshow:packagetest//import"test/testdoc"这个是a.go的包名的描述At20191017byBaiyu---a.goend---这个是在doc.go文件中的内容在Go的源代码中在Mac系统中在类Unix系统中在Windows系统中---doc.goend---这个是在testgodoc.go文件的内容packageName:testdescribe:程序的入口---testgodoc.goend---这个是z.go的包名描述---z.goend---constEmail...constBaiyu="baiyu"funcH(h2string,h3string)(reValuestring)funcTest(param1string,interint)(kstring)funcZ()typeComputerstruct{...}typePersonstruct{...}BUG:这个注释会生成在文档最后后面,同时因为紧跟着funZ,所以在上面的func列表里面也有显示功能:生成Z签名BUG:因为前面有BUG(who)这个关键字,所以这句注释就算没有紧跟关键字不会被隐藏掉BUG:BUG(6):格式正确,所以这句注释就算没有紧跟关键字不会被隐藏掉,前面的BUG():、BUG6:、BUG:都是不正确的BUG(who)命名
go doc <pkg>.<func>
查看pkg包下面的func函数的注释
example:godoctest.Testterminalshow:packagetest//import"test/testdoc"funcTest(param1string,interint)(kstring)功能:测试函数参数:param1:说明参数值inter:运算的数字返回值:k:返回值
如果想查看完整的源码go doc -src <pkg>.<func>
example:godoc-srctest.Testterminalshow:packagetest//import"test/testdoc"//功能:测试函数//参数://param1:说明参数值//inter:运算的数字//返回值://k:返回值funcTest(param1string,interint)(kstring){fmt.Println("测试函数")returnparam1}
在浏览器上查看
使用命令godoc -http=:6060
然后在打开浏览器的,在url输入localhost:6060/pkg
或者127.0.0.1:6060/pkg
就可以查看到你本地的所有包的信息了
如果你想要找到你特定的包名的话localhost:6060/pkg/<path>/<packageName>
或者127.0.0.1:6060/pkg/<path>/<packageName>
<path>
是你/src下包所在的路径<packageName>
是包名
导出godoc文档为HTML
使用命令godoc -url "http://localhost:6060/pkg/<pkg>/<packageName>/" > <packageName>.html
<pkg>
是你包所在的文件夹<packageName>
是你的包名
</div> <div class="zixun-tj-product adv-bottom"></div> </div> </div> <div class="prve-next-news">
golang如何获取注释内容的详细内容,希望对您有所帮助,信息来源于网络。