文章来源于网络收集而来,版权归原创者所有,如有侵权请及时联系!
3.6 与其他 Go 开发者合作
现代开发者不会一个人单打独斗,而 Go 工具也认可这个趋势,并为合作提供了支持。多亏了 go
工具链,包的概念没有被限制在本地开发环境中,而是做了扩展,从而支持现代合作方式。让我们看看在分布式开发环境里,想要良好合作,需要遵守的一些惯例。
以分享为目的创建代码库
开发人员一旦写了些非常棒的 Go 代码,就会很想把这些代码与 Go 社区的其他人分享。这其实很容易,只需要执行下面的步骤就可以。
1.包应该在代码库的根目录中
使用 go get
的时候,开发人员指定了要导入包的全路径。这意味着在创建想要分享的代码库的时候,包名应该就是代码库的名字,而且包的源代码应该位于代码库目录结构的根目录。
Go 语言新手常犯的一个错误是,在公用代码库里创建一个名为 code
或者 src
的目录。如果这么做,会让导入公用库的语句变得很长。为了避免过长的语句,只需要把包的源文件放在公用代码库的根目录就好。
2.包可以非常小
与其他语言相比,Go 语言的包一般相对较小。不要在意包只支持几个 API,或者只完成一项任务。在 Go 语言里,这样的包很常见,而且很受欢迎。
3.对代码执行 go fmt
和其他开源代码库一样,人们在试用代码前会通过源代码来判断代码的质量。开发人员需要在签入代码前执行 go fmt
,这样能让自己的代码可读性更好,而且不会由于一些字符的干扰(如制表符),在不同人的计算机上代码显示的效果不一样。
4.给代码写文档
Go 开发者用 godoc
来阅读文档,并且会用 http://godoc.org 这个网站来阅读开源包的文档。如果按照 go doc
的最佳实践来给代码写文档,包的文档在本地和线上都会很好看,更容易被别人发现。
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论