天枫庄资源网 Design By www.wosibo.com
Golang 推荐的命名规范
很少见人总结一些命名规范,也可能是笔者孤陋寡闻, 作为一个两年的golang 开发者, 我根据很多知名的项目,如 moby, kubernetess 等总结了一些常见的命名规范。 命名规范可以使得代码更容易与阅读, 更少的出现错误。
如有不同意见欢迎吐槽、讨论。 项目地址
文件命名规范
由于文件跟包无任何关系, 而又避免windows大小写的问题,所以推荐的明明规范如下: 文件名应一律使用小写, 不同单词之间用下划线分割, 命名应尽可能地见名知意
常量命名规范
常量明明用 camelcase来命名示例如下
const todayNews = "Hello" // 如果超过了一个常量应该用括号的方法来组织 const ( systemName = "What" sysVal = "dasdsada" )
变量命名规范
与常量命名方式一样,变量也应该使用驼峰的命名方式, 但注意尽量不与包名一致或者以包名开头
var x string x := 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 helloWorld
Struct命名规范
与接口命名规范类似
receiver 命名规范
golang 中存在receiver 的概念 receiver 名称应该尽量保持一致, 避免this, super,等其他语言的一些语义关键字如下
type A struct{} func (a *A) methodA() { } func (a *A) methodB() { a.methodA() }
注释规范
注释应一律使用双斜线
其他
格式化, 用tab不是空格, 可以与go fmt 兼容
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
标签:
Golang,命名规范
天枫庄资源网 Design By www.wosibo.com
广告合作:本站广告合作请联系QQ:858582 申请时备注:广告合作(否则不回)
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
天枫庄资源网 Design By www.wosibo.com
暂无详解Golang 推荐的命名规范的评论...
更新日志
2024年05月17日
2024年05月17日
- 华纳群星.1992-永远新一天华纳15周年金钻群星演唱会2CD【华纳】【WAV+CUE】
- 原声《功夫熊猫4 OST》[FLAC][545M]
- 陈奕迅《酝酿》[WAV分轨][502M]
- Taylor Swift《THE TORTURED POETS DEPARTMENT- THE ANTHOLOGY》[320K/MP3][279.09MB]
- 崔健《85回顾+梦中的倾诉》2CD [WAV+CUE][771M]
- 群星《安桥试音碟》3CD[FLAC][1.1G]
- Taylor Swift《THE TORTURED POETS DEPARTMENT- THE ANTHOLOGY》][24bit 48kH][FLAC/分轨]
- 群星1995-阿诗玛·中国歌剧金曲[中唱][WAV+CUE]
- [JVC]吴文光-中国古琴:流水[FLAC分轨]
- 刘欢.2004-经典20年珍藏锦集【新索】【WAV+CUE】
- 中唱唱片群星《好歌珍藏-游子情深》2CDWAV
- CD圣经上榜天碟1995-乌仁娜-《蒙古草原之歌》[WAV+CUE].
- 【电影原声】武满彻《旭日东升》1993[WAV+CUE整轨]
- Taylor Swift《THE TORTURED POETS DEPARTMENT》[320K/MP3][148.54MB]
- Taylor Swift《THE TORTURED POETS DEPARTMENT》[FLAC/分轨][405.72MB]