值得参考的golang语言开发规范:Uber Go 语言编码规范,一些优秀的技巧可以提升代码的质量、避免代码缺陷和bug漏洞

warning: 这篇文章距离上次修改已过193天,其中的内容可能已经有所变动。

以下是一些关键点摘录自Uber Go语言编码规范:

  1. 包名应该尽可能简短,并具有描述性,应该使用驼峰式命名法(PascalCase),但是为了避免和Go的内建名字冲突,包名应该尽可能包含独特的前缀。



package mypackage
  1. 函数名应该使用驼峰式命名法(PascalCase)。



func MyFunction() {
    // ...
}
  1. 变量名应该使用驼峰式命名法(PascalCase),但是局部变量应该使用小写字母开头的驼峰式命名法(camelCase)。



var MyVariable int
var myVariable int
  1. 常量名应该使用全部大写字母,并且使用下划线分隔。



const MyConstant = "Value"
  1. 对于接口命名,一般使用able后缀,如Reader, Writer, Formatter等。



type Reader interface {
    Read(p []byte) (n int, err error)
}
  1. 错误类型的名字应该是形容词结尾,例如Error, Invalid, Cannot等。



type Error struct {
    // ...
}
  1. 指针接收者应该用于 修改接收者对象的方法。



func (p *Point) ScaleBy(factor float64) {
    p.X *= factor
    p.Y *= factor
}
  1. 值接收者用于不需要修改接收者对象的方法。



func (p Point) Add(q Point) Point {
    return Point{p.X + q.X, p.Y + q.Y}
}
  1. 接口实现时,如果有指针或者值接收者的方法重载,应该同时提供两种方法。



func (p *Point) Add(q Point) Point {
    p.X += q.X
    p.Y += q.Y
    return *p
}
 
func (p Point) Add(q Point) Point {
    p.X += q.X
    p.Y += q.Y
    return p
}
  1. 应该使用err != nil来检查错误,而不是err == nil



if err != nil {
    // Handle error.
}

这些规范和技巧可以帮助Go语言开发者写出更加清晰、一致和可维护的代码。

最后修改于:2024年08月13日 09:28

评论已关闭

推荐阅读

DDPG 模型解析,附Pytorch完整代码
2024年11月24日
DQN 模型解析,附Pytorch完整代码
2024年11月24日
AIGC实战——Transformer模型
2024年12月01日
Socket TCP 和 UDP 编程基础(Python)
2024年11月30日
python , tcp , udp
如何使用 ChatGPT 进行学术润色?你需要这些指令
2024年12月01日
AI
最新 Python 调用 OpenAi 详细教程实现问答、图像合成、图像理解、语音合成、语音识别(详细教程)
2024年11月24日
ChatGPT 和 DALL·E 2 配合生成故事绘本
2024年12月01日
omegaconf,一个超强的 Python 库!
2024年11月24日
【视觉AIGC识别】误差特征、人脸伪造检测、其他类型假图检测
2024年12月01日
[超级详细]如何在深度学习训练模型过程中使用 GPU 加速
2024年11月29日
Python 物理引擎pymunk最完整教程
2024年11月27日
MediaPipe 人体姿态与手指关键点检测教程
2024年11月27日
深入了解 Taipy:Python 打造 Web 应用的全面教程
2024年11月26日
基于Transformer的时间序列预测模型
2024年11月25日
Python在金融大数据分析中的AI应用(股价分析、量化交易)实战
2024年11月25日
AIGC Gradio系列学习教程之Components
2024年12月01日
Python3 `asyncio` — 异步 I/O,事件循环和并发工具
2024年11月30日
llama-factory SFT系列教程:大模型在自定义数据集 LoRA 训练与部署
2024年12月01日
Python 多线程和多进程用法
2024年11月24日
Python socket详解,全网最全教程
2024年11月27日