编码规范

每个语言都有自己特色的编码规范,学习该语言的命名规范,能让你写出来的代码更加易读,更加不容易出现一些低级错误。我认为好的编码规范,有助于代码水平的提高,同时减少bug的产生。
另外需要注意的是:

  • go通过名称的首字母的大小写来控制函数的可见性
  • go的命名不能以数字部分符号开头
  • 不能使用保留字进行命名

文件命名

  • 一般go的文件名使用小写字母进行命名
  • 单词之间使用_下划线进行分隔
  • 如果是测试文件,可以使用_test.go结尾进行命名
  • 程序或应用的入口文件应使用main.go或程序或应用的名字全小写进行命名

包命名

保持package的名字和目录保持一致,尽量采取有意义的包名,简短,有意义,尽量和标准库不要冲突。包名应该为小写单词,不要使用下划线或者混合大小写。

结构体命名

  • 驼峰命名规则进行命名
  • 私有结构体首字母小写,然后按照驼峰命名规则进行命名
  • 公共结构体首字母大写,然后按照驼峰命名规则进行命名

函数命名

  • 驼峰命名规则进行命名
  • 私有函数首字母小写,然后按照驼峰命名规则进行命名
  • 公共函数首字母大写,然后按照驼峰命名规则进行命名
  • 函数参数排列顺序应以重要程度进行排序
  • 函数参数相同类型应尽量放在一起,可省略类型

接口命名

  • 驼峰命名规则进行命名
  • 私有函数首字母小写,然后按照驼峰命名规则进行命名
  • 公共函数首字母大写,然后按照驼峰命名规则进行命名

常量命名

以下两种方式都是可行的命名方式,我更倾向于后者

  • 以驼峰命名方式进行命名
  • 使用全大写且用下划线分隔单词进行命名

变量命名

  • 驼峰命名规则进行命名
  • 若变量为bool类型,可使用has,is,allow,can等单词开头
  • 私有变量首字母小写,然后按照驼峰命名规则进行命名
  • 公共变量首字母大写,然后按照驼峰命名规则进行命名

其他规范

  • 使用tab进行缩进
  • 一行最长不要超过80个字符
  • 声明的变量需要被使用,否则无法通过编译器编译
  • {应在代码后,}应另起一行

注释

包注释

  • 包注释在package关键字之前
  • 如果包有多个文件,只需在一个文件中编写即可
  • 如果需要为包中每个文件头部做注释,需要在包注释和package关键字之间加一行空行,否则该注释将会作为包注释

代码注释

  • 单行注释 :以//开头的一行
  • 多行注释:/* comment */

特别注释

  • //TODO:提醒维护人员此部分代码待完成
  • //FIXME:提醒维护人员此处有bug待修复
  • //NOTE:提醒维护人员需要关注的说明
文章作者: Willxup
本文链接:
版权声明: 本站所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 Willxup
Go Go
喜欢就支持一下吧