搭建公司內(nèi)部自己的 godoc 服務(wù)器
早期的go項目規(guī)范:
- 必須在GOPATH下
- 項目的包的命名路徑與git的路徑關(guān)聯(lián)
引入go modules之后,項目可以不在GOPATH內(nèi),包的命名也可以不包含git的路徑。
godoc 生成的文檔,只掃描GOPATH與GOROOT內(nèi)的代碼,在此之外的代碼無法生成在線文檔,詳見go-issue-26827
。
基于此歷史背景,一個較好的go項目規(guī)范如下:
- 項目統(tǒng)一命名規(guī)范帶上git路徑,格式:
module git.your-company.com/{business}/{your proj name}
為了兼容歷史與 godoc 方便生成文檔。 - go項目不強制放在GOPATH內(nèi)
- 使用go modules時,module 的命名規(guī)范參照第一條
- godoc 搭建文檔服務(wù)器時,go modules的項目使用軟鏈的形式鏈接到GOPATH內(nèi)
安裝與啟動
- 安裝:
go get golang.org/x/tools/cmd/godoc
- 啟動:
godoc -http=":3000"