搭建公司内部自己的 godoc 服务器

早期的go项目规范：

• 必须在GOPATH下
• 项目的包的命名路径与git的路径关联

引入go modules之后，项目可以不在GOPATH内，包的命名也可以不包含git的路径。

godoc 生成的文档，只扫描GOPATH与GOROOT内的代码，在此之外的代码无法生成在线文档，详见go-issue-26827
。

基于此历史背景，一个较好的go项目规范如下：

• 项目统一命名规范带上git路径，格式：module git.your-company.com/{business}/{your proj name}为了兼容历史与 godoc 方便生成文档。
• go项目不强制放在GOPATH内
• 使用go modules时，module 的命名规范参照第一条
• godoc 搭建文档服务器时，go modules的项目使用软链的形式链接到GOPATH内

安装与启动

• 安装：go get golang.org/x/tools/cmd/godoc
• 启动：godoc -http=":3000"

有疑问加站长微信联系（非本文作者）