详解Golang 推荐的命名规范

Golang 推荐的命名规范

很少见人总结一些命名规范，也可能是笔者孤陋寡闻， 作为一个两年的golang 开发者， 我根据很多知名的项目，如 moby, kubernetess 等总结了一些常见的命名规范。 命名规范可以使得代码更容易与阅读， 更少的出现错误。

如有不同意见欢迎吐槽、讨论。 项目地址

文件命名规范

由于文件跟包无任何关系， 而又避免windows大小写的问题，所以推荐的明明规范如下： 文件名应一律使用小写， 不同单词之间用下划线分割, 命名应尽可能地见名知意

常量命名规范

常量明明用 camelcase来命名示例如下

const todayNews = "Hello"

// 如果超过了一个常量应该用括号的方法来组织

const (
  systemName = "What"
  sysVal = "dasdsada"
)

变量命名规范

与常量命名方式一样，变量也应该使用驼峰的命名方式, 但注意尽量不与包名一致或者以包名开头

var x string
x := new(string)

函数命名规范

由于Golang的特殊性（用大小写来控制函数的可见性），除特殊的性能测试与单元测试函数之外, 都应该遵循如下原则

  1. 使用驼峰命名
  2. 如果包外不需要访问请用小写开头的函数
  3. 如果需要暴露出去给包外访问需要使用大写开头的函数名称

一个典型的函数命名方法如下：

// 注释一律使用双斜线， 对象暴露的方法
func (*fileDao) AddFile(file *model.File) bool {
  result := db.NewRecord(*file)
  if result {
   db.Create(file)
  }
  return result
}

// 不需要给包外访问的函数如下
func removeCommaAndQuote(content string) string {
  re, _ := regexp.Compile("[\\`\\,]+")
  return strings.TrimSpace(re.ReplaceAllString(content, ""))
}

接口命名规范

接口命名也是要遵循驼峰方式命名， 可以用 type alias 来定义大写开头的type 给包外访问

type helloWorld interface {
  func Hello();
}

type SayHello helloWorld

Struct命名规范

与接口命名规范类似

receiver 命名规范

golang 中存在receiver 的概念 receiver 名称应该尽量保持一致， 避免this, super，等其他语言的一些语义关键字如下

type A struct{}

func (a *A) methodA() {
}
func (a *A) methodB() {
  a.methodA()
}

注释规范

注释应一律使用双斜线

其他

格式化， 用tab不是空格， 可以与go fmt 兼容

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。

赞 (0)

相关推荐

  • Go语言学习技巧之命名规范

    前言 本篇主要讲述Go语言的命名规范.优秀的代码必须具备良好的可读性,而可读性的关键即在于命名风格. Go的函数.变量.常量.自定义类型.包(Package)的命名方式遵循以下规则: 1)首字符可以是任意的Unicode字符或者下划线 2)剩余字符可以是Unicode字符.下划线.数字 3)字符长度不限 Go只有25个关键字 break default func interface select case defer go map struct chan else goto package sw

  • 详解Golang 推荐的命名规范

    Golang 推荐的命名规范 很少见人总结一些命名规范,也可能是笔者孤陋寡闻, 作为一个两年的golang 开发者, 我根据很多知名的项目,如 moby, kubernetess 等总结了一些常见的命名规范. 命名规范可以使得代码更容易与阅读, 更少的出现错误. 如有不同意见欢迎吐槽.讨论. 项目地址 文件命名规范 由于文件跟包无任何关系, 而又避免windows大小写的问题,所以推荐的明明规范如下: 文件名应一律使用小写, 不同单词之间用下划线分割, 命名应尽可能地见名知意 常量命名规范 常量

  • 详解python里的命名规范

    文件名 全小写,可使用下划线 包 应该是简短的.小写的名字.如果下划线可以改善可读性可以加入.如mypackage. 模块 与包的规范同.如mymodule. 类 总是使用首字母大写单词串.如MyClass.内部类可以使用额外的前导下划线. 函数&方法 函数名应该为小写,可以用下划线风格单词以增加可读性.如:myfunction,my_example_function. *注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容. 函数和方法的参数 总使用"self&q

  • 详解Golang ProtoBuf的基本语法总结

    详解Golang ProtoBuf的基本语法总结

    目录 前言 基本规范 基本语法 package定义包 import 导入包 定义Message 定义Service 前言 最近项目是采用微服务架构开发的,各服务之间通过gPRC调用,基于ProtoBuf序列化协议进行数据通信,因此接触学习了Protobuf,本文会对Protobuf的语法做下总结,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助. gRPC的调用模型如下: 基本规范 文件以.proto做为文件后缀,除结构定义外的语句以分号结尾. rpc方法定义结尾的分号可有可无. Messag

  • 详解Golang使用MongoDB通用操作

    MongoDB是Nosql中常用的一种数据库,今天笔者就简单总结一下Golang如何使用这些通用的供能的,不喜勿喷...        研究的事例结构如下: type LikeBest struct { AuthorName string `bson:"authorname,omitempty"` BookName string `bson:"bookname,omitempty"` PublishTime string `bson:"publishtim

  • 详解Golang实现请求限流的几种办法

    简单的并发控制 利用 channel 的缓冲设定,我们就可以来实现并发的限制.我们只要在执行并发的同时,往一个带有缓冲的 channel 里写入点东西(随便写啥,内容不重要).让并发的 goroutine在执行完成后把这个 channel 里的东西给读走.这样整个并发的数量就讲控制在这个 channel的缓冲区大小上. 比如我们可以用一个 bool 类型的带缓冲 channel 作为并发限制的计数器. chLimit := make(chan bool, 1) 然后在并发执行的地方,每创建一个新

  • 详解Golang五种原子性操作的用法

    目录 Go 语言提供了哪些原子操作 互斥锁跟原子操作的区别 比较并交换 atomic.Value保证任意值的读写安全 总结 本文我们详细聊一下Go语言的原子操作的用法,啥是原子操作呢?顾名思义,原子操作就是具备原子性的操作... 是不是感觉说了跟没说一样,原子性的解释如下: 一个或者多个操作在 CPU 执行的过程中不被中断的特性,称为原子性(atomicity) .这些操作对外表现成一个不可分割的整体,他们要么都执行,要么都不执行,外界不会看到他们只执行到一半的状态. CPU执行一系列操作时不可

  • 详解golang 定时任务time.Sleep和time.Tick实现结果比较

    总的来说 Sleep是使用睡眠完成定时,结束后继续往下执行循环来实现定时任务. Tick函数是使用channel阻塞当前协程,完成定时任务的执行 现在来看一下 两种方法实现出来的效果有何不同 这里我们设置定时时长为5 使用“Do Something” 来模拟定时任务执行需要的时间 分1s执行,10s执行两种情况 代码如下 func Test_Sleep(t *testing.T) {     for i := 0; i < 3; i++ {         Debug("begin&quo

  • 详解Golang中Context的原理和使用技巧

    目录 Context 背景 和 适用场景 Context 的背景 Context 的功能和目的 Context 的基本使用 Context 的同步控制设计 Context 的定义和实现 Context interface 接口定义 parent Context 的具体实现 Context 的继承和各种 With 系列函数 Context 的常用方法实例 1. 调用 Context Done方法取消 2. 通过 context.WithValue 来传值 3. 超时取消 context.WithT

  • 详解Golang 与python中的字符串反转

    详解Golang 与python中的字符串反转 在go中,需要用rune来处理,因为涉及到中文或者一些字符ASCII编码大于255的. func main() { fmt.Println(reverse("Golang python")) } func reverse(src string) string { dst := []rune(src) len := len(dst) var result []rune result = make([]rune, 0) for i := le

  • 详解Golang 中的并发限制与超时控制

    前言 上回在 用 Go 写一个轻量级的 ssh 批量操作工具里提及过,我们做 Golang 并发的时候要对并发进行限制,对 goroutine 的执行要有超时控制.那会没有细说,这里展开讨论一下. 以下示例代码全部可以直接在 The Go Playground上运行测试: 并发 我们先来跑一个简单的并发看看 package main import ( "fmt" "time" ) func run(task_id, sleeptime int, ch chan st

随机推荐