golang godoc工具提取注释内容 golangcontext

godoc工具提取注释内容

安装: go get golang.org/x/tools/cmd/godoc

由于防火墙的原因, 国内的用户可能无法通过go get 命令无法安装 godoc 工具

部署方法:

> # wget https://github.com/golang/tools/archive/refs/tags/gopls/v0.8.3.tar.gz
> # tar -zxvf tools-gopls-v0.8.3.tar.gz
> # cd tools-gopls-v0.8.3/
> # cd cmd/godoc
> # go build
> # ls
doc.go godoc godoc_test.go goroot.go handlers.go main.go

将生成的 godoc 文件移动到 GOPATH 下的 bin 目录中。(需要把 GOPATH 下的 bin 目录添加到环境变量 Path 中)

export PATH=$PATH:/usr/local/go/bin
export GOPATH=/root/go
export PATH=$PATH:$GOPATH/bin
> # echo $GOPATH
/root/go
> # cp godoc /root/go/bin

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() 的使用说明。

main.go

//main包: 打印“Golang语言”
package main
import (
"fmt"
)
// 声明 main 主函数
func main() {
    fmt.Println("Golang") // 打印 “Golang”
}

> # go doc main.go

main包: 打印“Golang”

godoc 工具还可以获取 Go 安装目录下 /usr/local/go 中的注释内容, 并将这些注释内容整合到 web 服务器中供我们预览。

在命令行输入godoc -http=:6060, 然后使用浏览器打开 http://localhost:6060 后，就可以看到本地文档浏览服务器提供的页面。

> # godoc -http=:6060
using module mode; GOMOD=/dev/null

如云主机的外网IP: 112.74.106.92

开放端口号

> # firewall-cmd --permanent --zone=public --add-port=8080/tcp
> # firewall-cmd --reload

访问地址:

http://112.74.106.92:6060

我们就可以看到 golang 详细的帮助文档, 而且是当前的 golang 版本 的 文档

查看帮助:

> # godoc --help
usage: godoc -http=localhost:6060
-goroot string
Go root directory (default "/usr/local/go")
-http string
HTTP service address (default "localhost:6060")
......

godoc修改指定目录:

> # godoc -goroot=/data/shenlan -http=:6060