来自 google 的 andrew gerrand 曾经关于 go 中的参数命名规范进行了分享,slides 为 https://talks.golang.org/2014/names.slide
good name 将具有如下的特质:
consistent (easy to guess),short (easy to type),accurate (easy to understand)变量申明与变量使用之间越远,那么变量名字应当越长。
这也解释了,为什么 for 循环次数变量使用 i 作为遍历用的临时变量,而不是语义上更具体的 index 作为变量名。
我们不应该使用 names_with_underscores 作为变量名,而是 nameswithunderscores 作为变量名。
另一方面,首字母缩略词,应当是大写,例如 rvehttp 以及 idprocessor。
这被称为 mixedca,类似于驼峰原则命名,但是专业词汇的首字母缩写均应当写成大写形式。
变量名不是越长越好,常变量名会模糊代码功能。
常见的常量、类型组合可能使用非常简短的名字:
使用 i 而不是 index使用 r 而不是 reader使用 b 而不是 buffer根据上下文,避免使用冗余的名称:
在 runecount 方法内部,使用 count 而不是 reunecount在 map 语句中,使用 ok 而不是 keyinmap:v, ok := m[k]
常变量名也许在长函数、有很多变量的函数中有帮助,但是这通常也意味着你应该重构代码。
bad codes vs good codes
// badfunc runecount(buffer []byte) int { // runecount -> count runecount := 0 // index -> i , buffer -> b for index := 0; index < len(buffer); { if buffer[index] < runelf { index++ } el { // size -> n _, size := decoderune(buffer[index:]) index += size } runecount++ } return runecount}
// goodfunc runecount(b []byte) int { count := 0 for i := 0; i < len(b); { if b[i] &计算机3级lt; runelf { i++ } el { _, n := decoderune(b[i:]) i += n } count++ } return count}
函数参数与变量名一样,都起到了文档的作用。
1.当函数参数的类型具有描述性时,那么函数参数名就可以简短一些:
func afterfunc(d duration, f func()) *timerfunc escape(w io.writer, s []byte)
2.当函数参数的类型语义不清,那么参数名应当更具体详细一些:
func unix(c, nc int64) timefunc hasprefix(s, prefix []byt长征胜利的原因e) bool
导出函数(exported function)返回值应当仅仅出于编写文档目的进行命名。
下面是返回值命名的好例子:
// goodfunc copy(dst writer, src reader) (written int64, err error)// goodfunc scanbytes(data []byte, ateof bool) (advance int, token []byte, err error)
go 中结构体可以拥有方法,在为结构体声明方法时,结构体被称为 rec什么是数字eiver。
按照惯例,方法接收者的命名通常为 1 个字符或者 2 个字符,因为结构体的每一个方法都将使用同一个 receiver 名称。
// goodfunc (b *buffer) read(p []byte) (n int, err error)// goodfunc (sh rverhandler) rvehttp(rw responwriter, req *request)// goodfunc (r rectangle) size() point
receiver 的名称一定要确保一致性,如果结构体的 method1 使用 r 作为 receiver 名称,那么 method2 就不应当使用 rdr 作为名称。
package 级别的变量已经被 package name 限定了,因此需要注意导出变量、常量、函数、类型名的冗余问题。
例如:
我们使用 bytes.buffer 而不是 bytes.bytebuffer我们使用 strings.reader 而不是 strings.stringreader导出变量名不要与 package 之间存在冗余。
只有一个方法的接口,接口名通常简单在方法后面加上 er 来进行命令,例如:
type reader interface { read(p []byte) (n int, err error)}
有时候,上述策略会导致接口名语法不正确,但是我们仍然可以选择这么做,例如:
type execer interface { exec(query string, args []value) (result, error)}
也有时候,我们会修改接口名,使得其符合英语语法:
type bytereader interface { readbyte() (c byte, err error)}
当一个接口包含多个方法时,应当选择一个准确描述其用途的名称,例如 net.conn,http.responwriter,io.readwriter。
错误类型与错误变量应当有不同的命名格式:
// 错误类型 error typestype exiterror struct { ...}
// 错误变量 error valuesvar errformat = errors.new("image: unknown format")
选择对导出的名称具有意义的包名称。
避免使用 util、common 等包名。
使用短变量名
变量取名考虑上下文,避免冗余,例如函数内的局部变量考虑函数名,包导出变量考虑包名
到此这篇关于go中变量命名的文章就介绍到这了,更多相关go变量命名内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com!
本文发布于:2023-04-04 16:01:02,感谢您对本站的认可!
本文链接:https://www.wtabcd.cn/fanwen/zuowen/926f192ad181bcf1753108b84c32e38d.html
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
本文word下载地址:Go中变量命名规则与实例.doc
本文 PDF 下载地址:Go中变量命名规则与实例.pdf
留言与评论(共有 0 条评论) |