go godoc 文档服务器

cdz620 · · 1828 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

搭建公司内部自己的 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"

有疑问加站长微信联系(非本文作者)

本文来自:简书

感谢作者:cdz620

查看原文:go godoc 文档服务器

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

1828 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传