Go 语言命名规范:清晰、简洁、一致

Go 语言命名规范:清晰、简洁、一致

Go 语言是一门注重简洁和一致性的编程语言,良好的命名规范是代码可读性和维护性的关键因素之一。在本篇博客中,我们将深入探讨 Go 语言的命名规范,包括标识符、包名、常量、变量、函数等各个方面。

1. 标识符命名规范

1.1 包名

  • 包名应该是简短、清晰且有意义的名词。
  • 避免使用单个字符或者简写,除非是标准库中的惯例(如 fmtio)。
// Good
package geometry// Bad
package geo

1.2 常量

  • 常量使用驼峰式命名法,且尽量有意义。
  • 常量名应该全部大写,多个单词用下划线分隔。
// Good
const MaxRetryCount = 3// Bad
const MAX = 3

1.3 变量

  • 变量名应该是简洁、有意义的名词,采用驼峰式命名法。
  • 避免使用单个字符或者简写,除非是循环索引等简单场景。
// Good
var totalCount int// Bad
var tc int

1.4 函数

  • 函数名应该是动词或动词短语,具有描述性。
  • 函数名使用驼峰式命名法。
// Good
func calculateArea(radius float64) float64 {// ...
}// Bad
func caAr(r float64) float64 {// ...
}

2. Go 语言命名约定

2.1 结构体

  • 结构体的命名使用驼峰式命名法,并且应该是名词。
// Good
type Point2D struct {X float64Y float64
}// Bad
type xyCoord struct {x float64y float64
}

2.2 接口

  • 接口名应该是对其方法集的描述,以 er 结尾。
// Good
type Reader interface {Read() ([]byte, error)
}// Bad
type Read interface {Read() ([]byte, error)
}

2.3 错误类型

  • 错误类型的变量通常以 err 结尾。
// Good
var fileNotFoundError error// Bad
var notFound error

3. 一些额外的建议

3.1 短变量名

  • 在短生命周期的小范围内使用短变量名是可以接受的,但请确保有意义。
// Good (within a small scope)
func calculateArea(r float64) float64 {a := 3.14 * r * rreturn a
}

3.2 不要使用下划线分隔单词

  • Go 语言中不建议使用下划线 _ 分隔单词,而是使用驼峰式命名法。
// Good
var totalItemCount int// Bad
var total_item_count int

结语

Go 语言的命名规范注重代码的清晰性、简洁性和一致性。良好的命名规范有助于提高代码的可读性、可维护性,降低开发和维护成本。在实际编程中,遵循这些规范是写出高质量 Go 代码的关键之一。通过保持命名一致性,你将更容易理解和与其他开发者协作,使你的代码库更加健壮。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/633281.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

CentOS搭建DNS服务器

服务器规划 DNS服务器IP为:172.16.32.253 需要自定义域名解析 172.16.32.253 dns.zhangsan.com 172.16.32.128 test1.zhangsan.com 172.16.32.129 test2.zhangsan.com 172.16.32.130 www.zhangsan.com 1. 服务器初始化 [rootlocalhost ~]# hostnamectl set-hostnam…

源码:Spring常规Bean创建过程

Bean创建过程: 一、版本 5.3.10二、学习内容 Bean创建过程源码三、Bean生命周期 时间轴地址:点击 四、bean创建过程脑图总结 脑图地址:点击 五、源码过程 说明: bean创建入口一般都是通过getBean(xxx);方法进入的&#xf…

c# 弹出提示对话框

MessageBox.Show(); 显示消息窗口向用户展示消息。

elasticsearch[一]-索引库操作(轻松创建)、文档增删改查、批量写入(效率倍增)

elasticsearch[一]-索引库操作(轻松创建)、文档增删改查、批量写入(效率倍增) 1、初始化 RestClient 在 elasticsearch 提供的 API 中,与 elasticsearch 一切交互都封装在一个名为 RestHighLevelClient 的类中,必须先完成这个对象的初始化,…

python222网站实战(SpringBoot+SpringSecurity+MybatisPlus+thymeleaf+layui)-热门帖子推荐显示实现

锋哥原创的SpringbootLayui python222网站实战: python222网站实战课程视频教程(SpringBootPython爬虫实战) ( 火爆连载更新中... )_哔哩哔哩_bilibilipython222网站实战课程视频教程(SpringBootPython爬虫实战) ( 火…

李沐《动手学深度学习》线性神经网络 softmax回归

系列文章 李沐《动手学深度学习》预备知识 张量操作及数据处理 李沐《动手学深度学习》预备知识 线性代数及微积分 李沐《动手学深度学习》线性神经网络 线性回归 目录 系列文章一、softmax回归(一)问题背景(二)网络架构&#xf…

C# WebApi传参及Postman调试

概述 欢迎来到本文,本篇文章将会探讨C# WebApi中传递参数的方法。在WebApi中,参数传递是一个非常重要的概念,因为它使得我们能够从客户端获取数据,并将数据传递到服务器端进行处理。WebApi是一种使用HTTP协议进行通信的RESTful服…

数据分析案例-图书书籍数据可视化分析(文末送书)

🤵‍♂️ 个人主页:艾派森的个人主页 ✍🏻作者简介:Python学习者 🐋 希望大家多多支持,我们一起进步!😄 如果文章对你有帮助的话, 欢迎评论 💬点赞&#x1f4…

iPhone解锁工具---AnyMP4 iPhone Unlocker 中文

AnyMP4 iPhone Unlocker是一款功能强大的iPhone解锁软件,旨在帮助用户轻松解锁iPhone,从而在电脑上进行数据备份、传输和编辑。该软件支持多种iPhone型号,包括最新的iPhone 14系列,并支持多种解锁模式,如屏幕密码解锁、…

好用的流程图工具

分享工作中常用的装逼工具 目前市面上的流程图或者思维导图工具挺多的,但是有的会限制使用数量或者收费,典型的有processon、Xmind,推荐今天Mermaid(官网)。 快速上手 中文教程:Mermaid 初学者用户指南 | Mermaid 中文网。我们选择…

Android中矩阵Matrix实现平移,旋转,缩放和翻转的用法详细介绍

一,矩阵Matrix的数学原理 矩阵的数学原理涉及到矩阵的运算和变换,是高等代数学中的重要概念。在图形变换中,矩阵起到关键作用,通过矩阵的变换可以改变图形的位置、形状和大小。矩阵的运算是数值分析领域的重要问题,对…

UG阵列-数字递增

在UG中,我们对一个文本进行阵列,可以得到很多个相同文本,但是如果文本中的数据是递增数列,需要用到表达式 先画一根参考线,标注参考线长度,并记录系统生成对应长度的表达式,例如p15 然后插入一个…

Spring WebSocket实现实时通信的详细教程

简介 WebSocket 是基于TCP/IP协议,独立于HTTP协议的通信协议。WebSocket 连接允许客户端和服务器之间的全双工通信,以便任何一方都可以通过已建立的连接将数据推送到另一方。 我们常用的HTTP是客户端通过「请求-响应」的方式与服务器建立通信的&#x…

互联网加竞赛 基于机器视觉的停车位识别检测

简介 你是不是经常在停车场周围转来转去寻找停车位。如果你的车辆能准确地告诉你最近的停车位在哪里,那是不是很爽?事实证明,基于深度学习和OpenCV解决这个问题相对容易,只需获取停车场的实时视频即可。 该项目较为新颖&#xf…

2023 IoTDB Summit:北京城建智控科技股份有限公司高级研发主管刘喆《IoTDB在城市轨道交通综合监控系统中的应用》...

12 月 3 日,2023 IoTDB 用户大会在北京成功举行,收获强烈反响。本次峰会汇集了超 20 位大咖嘉宾带来工业互联网行业、技术、应用方向的精彩议题,多位学术泰斗、企业代表、开发者,深度分享了工业物联网时序数据库 IoTDB 的技术创新…

(设置非自定义Bean)学习Spring的第六天

一 . 获取Bean的方法详解 , 如下图 : 二 . Spring配置非自定义bean----DruidDatasource 我们举个例子 : 配置Druid数据源交由Spring管理 首先导入在pom文件Druid坐标 然后考虑 : 被配置的Bean的实例化方式是什么 : 无参构造 被配置的Bena是否要注入必要属性 : 四个基本信息…

lvgl chart 清空series数据

lvgl7 可以使用lv_chart_clear_series函数解决,那么lvgl8并没有相对应的series函数清除,反复看lvgl8代码,我发现可以通过设置线条全点值可以达到清除的目的 lv_chart_set_all_value(chart, series, LV_CHART_POINT_NONE); 重新通过lv_chart_…

图搜api按图搜索淘宝商品接口拍立淘API接口精准搜索商品代码调用案例

淘宝按图搜索淘宝商品(拍立淘)API接口接入入口的主要作用是帮助用户快速找到他们想要的商品。用户只需要上传一张包含所需商品的图片,该接口就会自动识别图片中的商品,并在淘宝平台上搜索出相应的商品。这不仅大大提高了用户的购物…

fastJson和jackson的日期数据处理

目录 1.jackson 2.fastjson 3.总结 1.jackson jackson是spring mvc默认的JSON解析方法,前端的数据序列化处理之后,后端经过反序列化处理可以直接使用实体对象进行接收。后端接口返回实体对象,经过序列化处理后前端可以接收并进行处理。 …

RabbitMQ之消息的可靠性传递

系列文章目录 提示:这里可以添加系列文章的所有文章的目录,目录需要自己手动添加 RabbitMQ之消息的可靠性传递 提示:写完文章后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录 系列文章目录前言一、消息的可…