Go中变量命名规则与实例

目录
  • 前言
  • 命名习惯很重要
  • 良好命名喜欢的特质
  • 经验法则
  • 大小写混用的变量名
  • 变量名避免冗余
  • 函数参数的命名
  • 返回值的命名
  • 方法 Receiver 的命名
  • 导出 package 级别变量命名
  • 接口类型
  • error 命名
  • Packages 名
  • 结论
  • 总结

前言

来自 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 作为变量名。

另一方面，首字母缩略词，应当是大写，例如 ServeHTTP 以及 IDProcessor。

这被称为 MixedCase，类似于驼峰原则命名，但是专业词汇的首字母缩写均应当写成大写形式。

变量名避免冗余

变量名不是越长越好，常变量名会模糊代码功能。

常见的常量、类型组合可能使用非常简短的名字：

  • 使用 i 而不是 index
  • 使用 r 而不是 reader
  • 使用 b 而不是 buffer

根据上下文，避免使用冗余的名称：

  • 在 RuneCount 方法内部，使用 count 而不是 reuneCount
  • 在 map 语句中，使用 ok 而不是 keyInMap：
v, ok := m[k]

常变量名也许在长函数、有很多变量的函数中有帮助，但是这通常也意味着你应该重构代码。

Bad codes vs good codes

// Bad
func RuneCount(buffer []byte) int {
      // runeCount -> count
    runeCount := 0
      // index -> i , buffer -> b
    for index := 0; index < len(buffer); {
        if buffer[index] < RuneSelf {
            index++
        } else {
              // size -> n
            _, size := DecodeRune(buffer[index:])
            index += size
        }
        runeCount++
    }
    return runeCount
}

// Good
func RuneCount(b []byte) int {
    count := 0
    for i := 0; i < len(b); {
        if b[i] < RuneSelf {
            i++
        } else {
            _, n := DecodeRune(b[i:])
            i += n
        }
        count++
    }
    return count
}

函数参数的命名

函数参数与变量名一样，都起到了文档的作用。

1.当函数参数的类型具有描述性时，那么函数参数名就可以简短一些：

func AfterFunc(d Duration, f func()) *Timer
func Escape(w io.Writer, s []byte)

2.当函数参数的类型语义不清，那么参数名应当更具体详细一些：

func Unix(sec, nsec int64) Time
​​​​​​​func HasPrefix(s, prefix []byte) bool

返回值的命名

导出函数（exported function）返回值应当仅仅出于编写文档目的进行命名。

下面是返回值命名的好例子：

// Good
func Copy(dst Writer, src Reader) (written int64, err error)
// Good
func ScanBytes(data []byte, atEOF bool) (advance int, token []byte, err error)

方法 Receiver 的命名

Go 中结构体可以拥有方法，在为结构体声明方法时，结构体被称为 receiver。

按照惯例，方法接收者的命名通常为 1 个字符或者 2 个字符，因为结构体的每一个方法都将使用同一个 receiver 名称。

// Good
func (b *Buffer) Read(p []byte) (n int, err error)
// Good
func (sh serverHandler) ServeHTTP(rw ResponseWriter, req *Request)
// Good
func (r Rectangle) Size() Point

Receiver 的名称一定要确保一致性，如果结构体的 method1 使用 r 作为 receiver 名称，那么 method2 就不应当使用 rdr 作为名称。

导出 package 级别变量命名

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.ResponseWriter，io.ReadWriter。

error 命名

错误类型与错误变量应当有不同的命名格式：

// 错误类型 Error types
type ExitError struct {
    ...
}

// 错误变量 Error values
var ErrFormat = errors.New("image: unknown format")

Packages 名

选择对导出的名称具有意义的包名称。

避免使用 util、common 等包名。

结论

使用短变量名

变量取名考虑上下文，避免冗余，例如函数内的局部变量考虑函数名，包导出变量考虑包名

总结

到此这篇关于Go中变量命名的文章就介绍到这了,更多相关Go变量命名内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • Go语言基础知识总结（语法、变量、数值类型、表达式、控制结构等）

    一.语法结构 golang源码采用UTF-8编码.空格包括:空白,tab,换行,回车. - 标识符由字母和数字组成(外加'_'),字母和数字都是Unicode编码. - 注释: 复制代码 代码如下: /* This is a comment; no nesting */ // So is this. 二.字面值(literals)类似C语言中的字面值,但数值不需要符号以及大小标志: 复制代码 代码如下: 23 0x0FF 1.234e7类似C中的字符串,但字符串是Unicode/UTF-8编码的

  • Go语言中的变量声明和赋值

    1.变量声明和赋值语法 Go语言中的变量声明使用关键字var,例如 复制代码 代码如下: var name string //声明变量 name = "tom" //给变量赋值 这边var是定义变量的关键字,name是变量名称,string是变量类型,=是赋值符号,tom是值.上面的程序分两步,第一步声明变量,第二步给变量赋值.也可以将两步合到一起. 复制代码 代码如下: var name string = "tom" 如果在声明时同时赋值,可以省略变量类型,Go语

  • go语言变量定义用法实例

    本文实例讲述了go语言变量定义用法.分享给大家供大家参考.具体如下: var语句定义了一个变量的列表:跟函数的参数列表一样,类型在后面. 复制代码 代码如下: package main import "fmt" var x, y, z int var c, python, java bool func main() {     fmt.Println(x, y, z, c, python, java) } 变量定义可以包含初始值,每个变量对应一个. 如果初始化是使用表达式,则可以省略类

  • Go语言声明一个多行字符串的变量

    Go如何声明一个多行字符串的变量?使用 ` 来包含即可. package main import ( "fmt" ) func main() { str := `hello world v2.0` fmt.Println(str) } Demo:http://play.golang.org/p/BOL8_SwQ0D 以上所述就是本文的全部内容了,希望大家能够喜欢.

  • Golang常用环境变量说明与设置详解

    无论你是使用Windows,Linux还是Mac OS操作系统来开发Go应用程序,在安装好Go安装语言开发工具之后,都必须配置好Go语言开发所要求的 环境变量,才算初步完成Go开发环境的搭建. 但对于一些初学者来说,可能不太明白Go语言中常用的环境变量(Environment variables)的作用以及如何设置环境变量,今天我们来讲讲. 注意:Go提供的Windows操作系统安装包(.msi后缀)安装完成后,会自动配置几个常用的环境变量. 常用环境变量 Go语言中可以设置的环境变量有很多,每

  • 详解Golang编程中的常量与变量

    详解Golang编程中的常量与变量

    Go语言常量 常量是指该程序可能无法在其执行期间改变的固定值.这些固定值也被称为文字. 常量可以是任何像一个整型常量,一个浮点常量,字符常量或字符串文字的基本数据类型.还有枚举常量. 常量是一样,只是它们的值不能自己定义后进行修改常规变量处理. 整型常量 一个整数文字可以是十进制,八进制,或十六进制常数.前缀指定基或基数:0x或0X的十六进制,0表示八进制,并没有为十进制. 一个整数文字也可以有一个后缀为U和L的组合,分别为无符号和长整型.后缀可以是大写或小写,并且可以以任意顺序. 这里是整数常

  • Go中变量命名规则与实例

    目录 前言 命名习惯很重要 良好命名喜欢的特质 经验法则 大小写混用的变量名 变量名避免冗余 函数参数的命名 返回值的命名 方法 Receiver 的命名 导出 package 级别变量命名 接口类型 error 命名 Packages 名 结论 总结 前言 来自 Google 的 Andrew Gerrand 曾经关于 Go 中的参数命名规范进行了分享,slides 为 https://talks.golang.org/2014/names.slide 命名习惯很重要 良好的可读性是高质量代码

  • 超全面的javascript中变量命名规则

    前言 变量的命名相对而言没有太多的技术含量,今天整理有关于变量命名相关的规则,主要是想告诉大家,虽然命名没有技术含量,但对于个人编码,或者说一个团队的再次开发及阅读是相当有用的.良好的书写规范可以让你的JavaScript代码更上一个台阶,也更有利于团队的再次开发和阅读代码. 全名原则 变量名区分大小写,允许包含字母.数字.美元符号($)和下划线,但第一个字符不允许是数字,不允许包含空格和其他标点符号 变量命名长度应该尽可能的短,并抓住要点,尽量在变量名中体现出值的类型 尽量避免使用没有意义的命

  • python中的变量命名规则详情

    目录 1.变量命名 1)命名的规范性 2)编程语言常用驼峰命名法 2. 变量命名的描述性 3.变量名尽量短,但是不要太短 4.合理使用变量 5. 变量定义尽量靠近使用 6. 合理使用namedtuple/dict 6. 控制单个函数内的变量数量 7. 删除掉没用的变量 8. 定义临时变量提高可读性 9. The Zen of Python 1.变量命名 1)命名的规范性 变量名可以包括字母.数字.下划线,但是数字不能做为开头. 系统关键字不能做变量名使用 除了下划线之个,其它符号不能做为变量名使

  • 和孩子一起学习python之变量命名规则

    变量命名规则 下面是关于变量名(也称为标识符)的一些规则 必须以一个字母或一个下划线字符开头.后面可以使用一个字母.数字或下划线字符的序列,长度不限. 字母可以是大写或小写,大小写是不同的.也就是说,Ax不同于aX. 数字可以是从0到9(包括0到9)的任意数字字符. 除了字母.数字和下划线字符,不能使用其他字符.空格.标点符号和其他字符在变量名中都是不允许的. 唯一允许出现的特殊字符是下划线字符.也许你不知道这是什么,下面给出几个例子: First_number=15 Student_name=

  • C#变量命名规则小结

    变量: 1.作用 :可以让我们在计算机中存储数据 2.语法:变量类型    变量名=赋值: 3.常用的数据类型: int   整数类型  取值范围:最大2147483647;最小-2147483648 double   小数类型  取值范围:最大 1.79769e+308;最小-1.79769e+308 string    字符串  "    " char    字符   ' ' decimal    金钱类型 bool   我们用bool类型来描述对或者错. true    对 fa

  • 你必须知道的JavaScript 变量命名规则详解

    变量命名还应遵守以下某条著名的命名规则: 著名的变量命名规则Camel 标记法首字母是小写的,接下来的字母都以大写字符开头.例如: 复制代码 代码如下: var testValue = 0, secondValue = "hi";Pascal 标记法 首字母是大写的,接下来的字母都以大写字符开头.例如: 复制代码 代码如下: var TestValue = 0, SecondValue = "hi";匈牙利类型标记法 在以 Pascal 标记法命名的变量前附加一个小

  • Python 变量命名规则和定义变量详解

    目录 一.定义变量 二.定义变量的规则 总结 一.定义变量 语法规则: 变量名 = 值 定义变量的语法规则中间的'=',并不是数学中等于号的意思,在编程语言中而是赋值的意思.赋值:其实程序在执行的时候,先计算等号('=')右边的值,然后把右边的值赋值给等号左边的变量名中. 注意点:变量名自定义,要满足标识符的命名规则. 二.定义变量的规则 标识符: 变量命名规范 - 标识符命名规则是Python中定义各种名字的时候的统一规范,具体规范如下: 1.由数字.字母.下划线组成 2.不能以数字开头 3.

  • javascript 命名规则 变量命名规则

    JavaScript变量匈牙利命名法 匈牙利命名法语法: 变量名＝类型+对象描述 类型指变量的类型 对象描述指对象名字全称或名字的一部分,要求有明确含义,命名要容易记忆容易理解. 提示: 虽然JavaScript变量表面上没有类型,但是JavaScript内部还是会为变量赋予相应的类型. 提示: 匈牙利命名法是一位微软程序员发明的,多数的C,C++程序都使用此命名法. JavaScript变量匈牙利命名类型 JavaScript变量起名类型 变量命名前缀 Array 数组 a Float 浮点

  • JavaScript 变量命名规则

    JScript 是一种区分大小写的语言. 第一个字符必须是一个 ASCII 字母(大小写均可),或一个下划线(_).注意第一个字符不能是数字. 后续的字符必须是字母.数字或下划线. 变量名称一定不能是 保留字. 下面给出合法变量名称的一些示例: _pagecount Part9 Number_Items 下面给出无效变量名称的一些示例: 99Balloons // 不能以数字开头.Smith&Wesson // "与"符号(&)字符用于变量名称是无效的.

  • Angular.JS中指令的命名规则详解

    命名规范 同一个AngularJS指令,在js文件和html文件中有着不同的命名规范:在js文件中使用标准的小驼峰命名法,在html文件中使用"小写字母+连接符"的命名法.如下表所示 在js文件中 在html文件中 ngApp ng-app myDirective my-directive 处理机制 AngularJS之所以选择这样的命名方式,是因为html文件不区分大小写,而js文件则对大小写敏感(myDir和mydir在js文件中是不同的指令,但html看来是同一个指令),为了避免

随机推荐