首页  >  文章  >  后端开发  >  golang怎么获取注释内容

golang怎么获取注释内容

青灯夜游
青灯夜游原创
2023-01-13 11:24:264553浏览

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

golang怎么获取注释内容

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

在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(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 中)

1.png

完成上述操作后就可以使用 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 后,就可以看到本地文档浏览服务器提供的页面。

3.gif

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 476311d4a5693dfd0d97cfc37db95983.c915ef6d477a95168a275e39c73b95bf查看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 476311d4a5693dfd0d97cfc37db95983.c915ef6d477a95168a275e39c73b95bf

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/98953a78f52873edae60a617ec082494/3dc77a3840d1fe4f8d7a0f0a6f003876或者127.0.0.1:6060/pkg/98953a78f52873edae60a617ec082494/3dc77a3840d1fe4f8d7a0f0a6f003876

  • 98953a78f52873edae60a617ec082494是你/src下包所在的路径

  • 3dc77a3840d1fe4f8d7a0f0a6f003876是包名

导出godoc文档为HTML

使用命令godoc -url "http://localhost:6060/pkg/476311d4a5693dfd0d97cfc37db95983/3dc77a3840d1fe4f8d7a0f0a6f003876/" > 3dc77a3840d1fe4f8d7a0f0a6f003876.html

  • 476311d4a5693dfd0d97cfc37db95983是你包所在的文件夹

  • 3dc77a3840d1fe4f8d7a0f0a6f003876是你的包名

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

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

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

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

【相关推荐:Go视频教程编程教学

以上是golang怎么获取注释内容的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn