[dev] Go语言查看doc与生成API doc

Posted 2021-11-01 hugetong

类似与javadoc，go也可以自动生成doc文档。

方法有两个：

1. 使用go doc工具

可以查看它的详细文档：

go help doc

示例：

在这个目录下，我创建一个api包

╰─>$ pwd
/home/tong/Src/go/src/local/test/api/api.go

代码是这样的：

package api

import "fmt"

type TestApi struct {
    var1 int
    var2 int
    var3 string
    Var4 int
    Var5 string
}

func (p *TestApi) internalFunc() {
    fmt.Println("I am Test.")
}

func (p *TestApi) Func1() {
    p.internalFunc()
}

func (p *TestApi) Func2() {
    p.internalFunc()
}

 

可以使用如下命令查看API：

package api

import "fmt"

type TestApi struct {
    var1 int
    var2 int
    var3 string
    Var4 int
    Var5 string
}

func (p *TestApi) internalFunc() {
    fmt.Println("I am Test.")
}

func (p *TestApi) Func1() {
    p.internalFunc()
}

func (p *TestApi) Func2() {
    p.internalFunc()
}

 

2 使用godoc工具

还有一个工具，叫godoc，需要单独安装 https://godoc.org/golang.org/x/tools/cmd/godoc

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

build之后，会生成在GOPATH/bin下。

然后，运行这个工具，他会开启一个http服务在6060端口

┬─[[email protected]:~/Src/go/src/local/test/api]─[02:49:26 PM]
╰─>$ $GOPATH/bin/godoc

你的所有go工程下代码的api都能根据包的树结构进行查看。访问如下url，可以查看前文目标包的所有API

http://127.0.0.1:6060/pkg/local/test/api/

如图：

 

3. 把API文档保存出来的话，可以这样

$GOPATH/bin/godoc -url "http://localhost:6060/pkg/container/heap/" > page.html

但是，网页外链太多的话，其实并不好用。