golang推荐的命名规范

这篇具有很好参考价值的文章主要介绍了golang推荐的命名规范。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

二 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()
}

注释规范文章来源地址https://www.toymoban.com/news/detail-433392.html

  • 注释应一律使用双斜线

到了这里,关于golang推荐的命名规范的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • SQL sever命名规范

    目录 一、标识符 二、表名(Table): 三、字段名(fields): 四、约束(Constraint): 五、索引(Index): 六、存储过程(Stored Procedure): 七、函数(Function): 八、触发器(Trigger): 九、视图(View): 十、大小写       在生活实际工作中,常需要在SQL sever数据库中开发一

    2024年02月09日
    浏览(27)
  • Python的命名规范

    python变量名区分大小写,也就是Student和student在python语言中代表两个不同的名字。 也就是说,student_id、student1、student_1、student、_student、_等都是合理的命名,但是1student就是非法的命名。 python变量命名一般采用蛇形命名法(毕竟python的本意就是大蟒蛇),也就是如果变量名由

    2024年02月09日
    浏览(26)
  • alibaba命名规范

    1.类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO / PO / UID 等 2.方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。 3.抽象类命名使用Abstract或Base开头;异常类命名使用Exception 结尾;测试类命名以它要测试的类的名称开始,

    2024年02月10日
    浏览(31)
  • restful风格接口命名规范

    (一)rest 1.概念 REST即表述性状态传递(英文:Representational State Transfer,简称REST)是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。它是一种针对网络应用的设计和开发方式,可以降低开发的复杂性,提高系统的可伸缩性。 可理解为: URL定位资源,用H

    2024年02月02日
    浏览(32)
  • git分支命名规范

    格式: master 功能概述: 永远是可用的稳定版本,不能直接在该分支上开发。 1.开发主分支 格式: dev 功能概述: 所有新功能以这个分支来创建自己的开发分支,该分支只做合并操作,不能直接在该分支上进行开发。 2.功能开发分支 格式: feature-{功能描述}-{姓名拼音首字母连写}

    2024年02月12日
    浏览(25)
  • 命名规范,进制

    包名小写 类名或者接口明,所有单词首字母大写。大驼峰命名法 方法名和方法名,第一个单词小写,后面的单词首字母大写。小驼峰命名法 简称驼峰法 常量,所有的字母大写,单词之间用_线连接 二进制 0b或者0B开头 如: int n1 = 0b1010; 八进制 以0开头 如:int n2 = 01010; 十进制

    2024年02月09日
    浏览(23)
  • 数据仓库命名规范详解

    养成良好的编程习惯 写出清楚、易懂、易维护的程序代码 提高代码质量与沟通效率 减少编码中的不必要的错误 (1)数据仓库命名规范 (2)表命名规范 (3)字段命名规范 (4)字段类型规范 (1)数据仓库命名规范 (2)表命名规范 命名全部采用小写字母和数字构成,只能

    2024年02月02日
    浏览(86)
  • 01 QT命名规范,快捷键

    类名首字母大写,单词和单词之间首字母大写 函数名、变量名 首字母小写,单词和单词之间首字母大写 运行:ctrl + r 编译:ctrl + b 注释:ctrl + / 字体缩放:ctrl + 鼠标滚轮 整行移动:ctrl + shift + 上键/下键 自动对齐:ctrl + i 同名的.h文件和.cpp文件切换:F4 查找:ctrl

    2024年02月16日
    浏览(34)
  • C 模拟类的命名规范

    版面格式 a. 空行的使用 空行起着分隔程序段落的作用, 空行得体(不过多也不过少)将使程序的布局更加清晰。在一个函数体内, 逻揖上密切相关的语句之间不加空行, 其它地方应加空行分隔。 b. 语句与代码行 1). 一行代码只做一件事情, 如只定义一个变量或只写一条语句, 这样

    2024年02月09日
    浏览(21)
  • Java 命名规范(非常全),收藏了!

    在本文中,将从大到小,从外到内,总结Java编程中的命名规范。文中将会涉及到日常工作中常见的命名示例,如包命名,类命名,接口命名,方法命名,变量命名,常类命名,抽象类命名,异常类命名以及扩展类命名等。我将按照项目工程目录结构,从包,类(接口,抽象类

    2024年02月03日
    浏览(22)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包