目录[-]
golang编码规范
gofmt
注释
命名
控制结构
函数(必须)
错误处理
panic
import
缩写
参数传递
接受者
golang编码规范
注:此文档参考官方指南Effective Golang和Golang Code Review Comments进行整理,力图与官方及社区编码风格保持一致。
gofmt
大部分的格式问题可以通过gofmt解决,gofmt自动格式化代码,保证所有的go代码一致的格式。
正常情况下,采用Sublime编写go代码时,插件GoSublilme已经调用gofmt对代码实现了格式化。
注释
在编码阶段同步写好变量、函数、包注释,注释可以通过godoc导出生成文档。
注释必须是完整的句子,以需要注释的内容作为开头,句点作为结尾。
程序中每一个被导出的(大写的)名字,都应该有一个文档注释。
包注释
每个程序包都应该有一个包注释,一个位于package子句之前的块注释或行注释。
包如果有多个go文件,只需要出现在一个go文件中即可。
?
1
2
3
//Package regexp implements a simple library
//for regular expressions.
package regexp
可导出类型
第一条语句应该为一条概括语句,并且使用被声明的名字作为开头。
?
1
2
3
// Compile parses a regular expression and returns, if successful, a Regexp
// object that can be used to match against text.
func Compile(str string) (regexp *Regexp, err error) {
命名
使用短命名,长名字并不会自动使得事物更易读,文档注释会比格外长的名字更有用。
包名
包名应该为小写单词,不要使用下划线或者混合大小写。
接口名
单个函数的接口名以"er"作为后缀,如Reader,Writer
接口的实现则去掉“er”
?
1
2
3
type Reader interface {
Read(p []byte) (n int, err error)
}
两个函数的接口名综合两个函数名
?
1
2
3
4
type WriteFlusher interface {
Write([]byte) (int, error)
Flush() error
}
三个以上函数的接口名,类似于结构体名
?
1
2
3
4
5
type Car interface {
Start([]byte)
Stop() error
Recover()
}
混合大小写
采用驼峰式命名
?
1
2
MixedCaps 大写开头,可导出
mixedCaps 小写开头,不可导出
控制结构
if
if接受初始化语句,约定如下方式建立局部变量
?
1
2
3
if err := file.Chmod(0664); err != nil {
return err
}
for
采用短声明建立局部变量
?
1
2
3
4
sum := 0
for i := 0; i < 10; i++ {
sum += i
}
range
如果只需要第一项(key),就丢弃第二个:
?
1
2
3
4
5
for key := range m {
if key.expired() {
delete(m, key)
}
}
如果只需要第二项,则把第一项置为下划线
?
1
2
3
4
sum := 0
for _, value := range array {
sum += value
}
return
尽早return:一旦有错误发生,马上返回
?
1
2
3
4
5
6
7
8
9
10
f, err := os.Open(name)
if err != nil {
return err
}
d, err := f.Stat()
if err != nil {
f.Close()
return err
}
codeUsing(f, d)
函数(必须)
函数采用命名的多值返回
传入变量和返回变量以小写字母开头
?
1
func nextInt(b []byte, pos int) (value, nextPos int) {
在godoc生成的文档中,带有返回值的函数声明更利于理解
错误处理
error作为函数的值返回,必须对error进行处理
错误描述如果是英文必须为小写,不需要标点结尾
采用独立的错误流进行处理
不要采用这种方式
?
1
2
3
4
5
if err != nil {
// error handling
} else {
// normal code
}
而要采用下面的方式
?
1
2
3
4
5
if err != nil {
// error handling
return // or continue, etc.
}
// normal code
如果返回值需要初始化,则采用下面的方式
?
1
2
3
4
5
6
x, err := f()
if err != nil {
// error handling
return
}
// use x
panic
尽量不要使用panic,除非你知道你在做什么
import
对import的包进行分组管理,而且标准库作为第一组
?
1
2
3
4
5
6
7
8
9
10
11
12
13
package main
import (
"fmt"
"hash/adler32"
"os"
"appengine/user"
"appengine/foo"
"code.google.com/p/x/y"
"github.com/foo/bar"
)
goimports实现了自动格式化
缩写
采用全部大写或者全部小写来表示缩写单词
比如对于url这个单词,不要使用
?
1
UrlPony
而要使用
?
1
urlPony 或者 URLPony
参数传递
对于少量数据,不要传递指针
对于大量数据的struct可以考虑使用指针
传入参数是map,slice,chan不要传递指针
因为map,slice,chan是引用类型,不需要传递指针的指针
接受者
名称
统一采用单字母'p'而不是this,me或者self
?
1
2
3
type T struct{}
func (p *T)Get(){}
类型
对于go初学者,接受者的类型如果不清楚,统一采用指针型
?
1
func (p *T)Get(){}
而不是
?
1
func (p T)Get(){}
在某些情况下,出于性能的考虑,或者类型本来就是引用类型,有一些特例
如果接收者是map,slice或者chan,不要用指针传递
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//Map
package main
import (
"fmt"
)
type mp map[string]string
func (m mp) Set(k, v string) {
m[k] = v
}
func main() {
m := make(mp)
m.Set("k", "v")
fmt.Println(m)
}
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
//Channel
package main
import (
"fmt"
)
type ch chan interface{}
func (c ch) Push(i interface{}) {
c <- i
}
func (c ch) Pop() interface{} {
return <-c
}
func main() {
c := make(ch, 1)
c.Push("i")
fmt.Println(c.Pop())
}
如果需要对slice进行修改,通过返回值的方式重新赋值
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//Slice
package main
import (
"fmt"
)
type slice []byte
func main() {
s := make(slice, 0)
s = s.addOne(42)
fmt.Println(s)
}
func (s slice) addOne(b byte) []byte {
return append(s, b)
}
如果接收者是含有sync.Mutex或者类似同步字段的结构体,必须使用指针传递避免复制
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package main
import (
"sync"
)
type T struct {
m sync.Mutex
}
func (t *T) lock() {
t.m.Lock()
}
/*
Wrong !!!
func (t T) lock() {
t.m.Lock()
}
*/
func main() {
t := new(T)
t.lock()
}
如果接收者是大的结构体或者数组,使用指针传递会更有效率。
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package main
import (
"fmt"
)
type T struct {
data [1024]byte
}
func (t *T) Get() byte {
return t.data[0]
}
func main() {
t := new(T)
fmt.Println(t.Get())
}
相关推荐
主要介绍了golang语言编码规范的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
NULL 博文链接:https://yin-xudong.iteye.com/blog/793120
Uber Go 语言编码规范中文版.md
用来记录我们刷LeetCode题目时候的心酸...编程语言使用Golang,代码风格上面并没有强制的采用什么编码规范,毕竟是算法解题,只需要代码清晰易懂就可以了。 鉴于个人精力时间有限,可能并不会完全最优解,请多多见谅。
只需要开启Encoding选项支持连接自动回收,支持无错误获取连接,代码调用更简便2.0主要改进修改所有函数名字,使其符合golang编码规范,通过 golint 验证改进协议实现方式,提高解析效率改进连接池方式,提高连接池...
一、Hello World 1、创建项目 GoLand下:new—》project—》 创建好以后,只是个空项目: 2、编辑运行/调试配置 ... 选择 Go Build: ...关于下面配置项的一些说明: Name:为配置信息项的名称,配置好后,显示这样: ...
主要参考极客时间《Go 语言项目开发实战》规范设计。 首先理解工程化规范包括的两方面...1.6. 编码规范 1.7. 代码测试 1.8. 性能分析 1.9. API 设计 1.10. 项目管理 1.11. 项目部署 1.12. 研发流程示例 1.13. 参考资料
初识Go语言 Go语言地发展历史 • Go语言地优势与特点 • 安装与配置Golang • GoLand安装与配置 • Go语言地优势与特点 • Go语言程序结构及编码规范
其开源了很多 golang 项目,诸如被 Gopher 圈熟知的 zap、jaeger 等。2018 年年末 Uber 将内部的 Go 风格规范 开源到 GitHub,经过一年的积累和更新,该规范已经初具规模,并受到广大 Gopher 的关注。本文是该规范...
Go中的DICOM解析器 ... 更改为: 许多错误修复,尤其是在处理序列方面。 更正确地处理非ASCII字符。...我要感谢我的朋友帮助我完成了可怕的DICOM图像规范以及解析器中一些较难的部分。 使该库栩栩如生的
尽管堆积了许多问题和PR,但该库目前最主要的缺点是它已落后于上游TOML规范。 许多人仍在使用此程序包,只要您感到满意,就没有紧迫的理由切换到其他程序。 话虽如此,组织一个现有的替代方案或分支该项目并对其...
记录我用Golang语言刷LeetCode上的算法题目时候的学习过程 代码风格上面并没有强制的采用什么编码规范,毕竟是算法解题,只需要代码清晰易懂就可以了。
这是一个用于解码和编码快速流式传输格式的小型golang库,在此处指定: : 请注意,snappy的流式传输或成帧格式与snappy本身不同。 可以将其视为一列棚车:流式格式将您的数据分成多个块,单独将快照应用于每个块,...
Go gin Gin是一个golang的微框架,封装比较优雅,API友好,源码注释比较明确,已经发布了1.0版本。具有快速灵活,容错方便...借助框架开发,不仅可以省去很多常用的封装带来的时间,也有助于团队的编码风格和形成规范。
$ go get gopkg.in/gin-gonic/gin.v1由于被墙,会下载失败,这里提供下载好的包。 Gin是一个golang的微框架,封装比较优雅...借助框架开发,不仅可以省去很多常用的封装带来的时间,也有助于团队的编码风格和形成规范。
编码实现的关键是要保证代码的质量和可维护性,遵循Go语言的编码规范和最佳实践。 单元测试:单元测试是确保代码质量的重要手段之一。通过编写测试用例并执行测试,可以验证代码的正确性和稳定性。Go语言内置了测试...
用于解码和编码ASE(Adobe Swatch Exchange)文件的Golang软件包。 ASE规范可在找到。 安装 $ go get github.com/arolek/ase 入门 ASE包公开了Decode and Encode方法。 您只需将io.Reader接口传递给ase.Decode,它...
该存储库包含Java,C ++,Golang和C#的参考实现。 有关SBE的设计和使用的更多详细信息,请参见 。 可以在找到适用于SBE规范的XSD。 请向提出有关规范的问题。 有关最新版本信息和更改,请参阅带有下载的。 ...
tmxgo ...基于来自的 TMX 规范。 支持: Gzip压缩 Zlib 压缩 Base64 编码的瓦片 未编码的图块元素 将地图序列化回字符串(用于编辑 + 保存) 去做: 支持CSV编码。 完整规范的单元测试。 文档
迪康高性能Golang DICOM医学图像解析器 :eyes: v1.0刚刚发布! 这是一个库和命令行...将数据集写回并编码回DICOM文件 增强的测试和基准测试支持 现代,规范的Go。用法要在您的golang项目中使用它,请导入github.com/s