[dev] Go語言查看doc與生成API doc

類似與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端口

┬─[tong@T7:~/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

但是，網頁外鏈太多的話，其實並不好用。