时间:2021-05-23
Golang 推荐的命名规范
很少见人总结一些命名规范,也可能是笔者孤陋寡闻, 作为一个两年的golang 开发者, 我根据很多知名的项目,如 moby, kubernetess 等总结了一些常见的命名规范。 命名规范可以使得代码更容易与阅读, 更少的出现错误。
如有不同意见欢迎吐槽、讨论。 项目地址
文件命名规范
由于文件跟包无任何关系, 而又避免windows大小写的问题,所以推荐的明明规范如下: 文件名应一律使用小写, 不同单词之间用下划线分割, 命名应尽可能地见名知意
常量命名规范
常量明明用 camelcase来命名示例如下
const todayNews = "Hello"// 如果超过了一个常量应该用括号的方法来组织const ( systemName = "What" sysVal = "dasdsada")变量命名规范
与常量命名方式一样,变量也应该使用驼峰的命名方式, 但注意尽量不与包名一致或者以包名开头
var x stringx := new(string)函数命名规范
由于Golang的特殊性(用大小写来控制函数的可见性),除特殊的性能测试与单元测试函数之外, 都应该遵循如下原则
一个典型的函数命名方法如下:
// 注释一律使用双斜线, 对象暴露的方法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 helloWorldStruct命名规范
与接口命名规范类似
receiver 命名规范
golang 中存在receiver 的概念 receiver 名称应该尽量保持一致, 避免this, super,等其他语言的一些语义关键字如下
type A struct{}func (a *A) methodA() {}func (a *A) methodB() { a.methodA()}注释规范
注释应一律使用双斜线
其他
格式化, 用tab不是空格, 可以与go fmt 兼容
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
代码规范、git规范、teambition规范、yii规范1.命名规范(1).变量命名规范1.变量使用驼峰命名法禁止使用拼音或者拼音加数字2.变量也应具有描述性
Golang开发环境搭建Go语言开发包国外:https://golang.org/dl/国内(推荐):https://golang.google.cn/dl/编
本文实例讲述了thinkPHP5.0框架开发规范。分享给大家供大家参考,具体如下:命名规范ThinkPHP5遵循PSR-2命名规范和PSR-4自动加载规范,并且
良好的命名习惯是一种美德,下面是个人整理的数据库命名规范: 数据库命名规范: 1.数据库名: 1.1)用产品或项目的名字命名; 1.2)Pascal
码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。代码编写规范使用范围:J2EE项目开发。包命名规范:目的:包的命名规范应当体现