Go编程规范 - Golang学习笔记

最新推荐文章于 2023-08-29 23:33:36 发布
最新推荐文章于 2023-08-29 23:33:36 发布
阅读量268 收藏 1
点赞数 1
分类专栏： 学习笔记 文章标签： golang
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_26228619/article/details/120853325
版权

Go编程规范

可以用的工具

gofmt：代码修正

goimports：修正import包规范

golint：检测规范 https://github.com/golang/lint （官方已停止支持）

Staticcheck：也是一个代码检测工具 https://staticcheck.io/

1. Comment Sentences

注释应该是一个完整的句子，有利于转化godoc

2. Declaring Empty Slices

var t []string

可避免内存分配

3. Doc Comments

包注释建议C注释风格（/* */），public函数都应该有注释

4. Don’t Panic

尽量不要使用panic处理错误

5. Error Strings

错误提示不需要开头大写也不需要句号结尾

6. Handle Errors

不要将error赋值给匿名变量_，一定要处理error

7. Imports

import多个包时应该分组，标准库放在第一组

8. Indent Error Flow

减少正常逻辑代码的缩进

if err != nil {
    // error handling
    return // or continue, etc.
}
// normal code

9. Initialisms

保持首字母大写和缩写的风格，不要混用

appleID✔ appleId❌

10. Line Length

一行别太长

11. Mixed Caps

驼峰式命名，public大写开头，private小写开头

12. Named Result Parameters

给返回值命名

13. Package Names

全小写，要简短

14. Pass Values

除非时庞大的结构体不然别传指针

15. Receiver Names

结构体函数中接受者命名使用简短的命名风格

Client -> c 或 cl

16. Receiver Type

如果不清楚就选指针

建议指针的情况:
  • 当函数内部需要修改接受者
  • 当接受者是一个结构体，且包含了sync.Mutex或者类似的用于同步的成员（避免拷贝）
  • 当接受者类型是一个结构体或数组并且很庞大（提高性能）
  • 当接受者是结构体，数组或slice，并且其中的元素是指针，函数内部可能修改这些元素时
不用指针的情况:
  • map，chan，func 本身就是引用类型
  • slice 函数内部不会对slice进行切片或者重新分配空间
  • 小型结构体，小数组，并且不需要修改里面的元素

17. Variable Names

变量命名尽可能短，尤其是局部变量

一些特殊的变量以及全局变量，可能需要更多描述，使用长命名也行

代码检查工具Staticcheck使用方法：

安装：

go get honnef.co/go/tools/cmd/staticcheck

检查当前package：

staticcheck .

检查所有package：

staticcheck ./...

check查询：

staticcheck -explain <check>
相关阅读：
蜡笔小星123
关注
  • 1
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
golang staticcheck
sky527759的博客
10-04 4192
staticcheck.io 下面是摘抄出来的几个： SA6001 – Missing an optimization opportunity when indexing maps by byte slices Map keys must be comparable, which precludes the use of byte slices. This usually leads to using string keys and converting byte slices to strings. No
Go编程语言-Golang开发
05-26
Go是一种开放源代码编程语言，可轻松构建简单，可靠且高效的代码。Go编程语言Go是一种开放源代码编程语言，可使其轻松构建简单，可靠和高效的软件。 由Renee French制作的Gopher图片，已获得知识共享3.0署名许可。 我们规范的Git存储库位于https://go.googlesource.com/go。 在https://github.com/golang/go上有一个存储库的镜像。 除非另有说明，否则Go源文件将根据LICENSE文件中的BSD样式许可进行分发。 下载
Go语言最全编码规范
最新发布
下载完，不懂运行可以私聊，看到会回
08-29 830
在编程中，命名规范、注释规范和代码格式化是提高代码质量、可读性和可维护性的关键因素。本文将深入介绍Go语言中的这些规范和最佳实践，并讨论 gofmt工具的使用。注释在代码中起到解释、文档和指导作用，能够帮助其他开发人员更好地理解代码的意图和功能。Go提供C风格的/* */块注释和C ++风格的//行注释。单行注释：单行注释是最常见的注释形式，以 // 开头，可以在代码的任何位置使用。单行注释通常用于对特定代码行或语句进行简短的解释。// 这是一个单行注释") // 这是另一个单行注释。
GO语言学习之高质量编程及编码规范
youcpdd的博客
01-17 210
1.编码规范2.性能优化建议3.性能调4.优实战5.性能调优简介6.性能分析工具pprof实战。
golang语言规范
weixin_43827495的博客
06-25 214
7、注意闭包的使用，在循环中调用函数或者goroutine方法，一定要采用显示的变量调用，不要再闭包函数里面调用循环的参数。保持package的名字和目录保持一致，尽量采取有意义的包名，简短，有意义，尽量和标准库不要冲突。1、如果你的包引入了三种类型的包，标准库包，程序内部包，第三方包，建议采用如下方式进行组织你的包。不同的类型采用空格分离，第一种实标准库，第二是项目包，第三是第三方包。多写关键函数的注释，活用**//TODO，//FIXME**尽量采取有意义的文件名，简短，有意义，应该为。
Go项目的安全评估技术
TonyBai
11-09 2145
在今年夏天我们对Kubernetes的评估成功之后，我们收到了大量Go项目的安全评估需求。为此，我们将在其他编译语言中使用过的安全评估技术和策略调整适配到多个Go项目中。...
Go-Golang笔记
08-14
Go语言，也称为Golang，是由Google开发的一种静态类型的、编译式的、并发型且具有垃圾回收功能的编程语言。自2009年发布以来，Go语言因其简洁的语法、高效的性能以及对并发处理的良好支持，逐渐在云计算、网络服务和...
golang:go语言学习笔记
03-29
go语言学习笔记 该仓库记录的go语言学习笔记 一go语言基础 go语言特点： 运行效率高，且简单易学 跨平台 丰富的标准库 可以直接使用c代码 语言规范支持并发 本节主要内容如下 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9...
golang-learning:高朗的笔记本
05-06
《Golang学习笔记：深入探索Go语言编程世界》 Golang，由Google开发的开源编程语言，因其简洁、高效和并发特性而备受开发者喜爱。"golang-learning"是一份全面的Go语言学习资源，旨在帮助程序员们深入理解并熟练...
Go语言学习（四） 工程实践-青训营笔记
08-17
通过这个青训营的学习笔记，我们可以了解到如何利用Go语言进行高效、可靠的软件开发。 首先，Go语言的工程实践主要体现在其模块化管理和构建工具上。Go 1.11 引入了官方的模块支持，允许开发者通过`go mod`命令管理...
Go 编程语言规范
maimang1001的专栏
09-21 6203
转自：http://ilovers.sinaapp.com/doc/golang-specification.html Go 编程语言规范 2013年05月08日版本 简介记号源代码表示字符字母和数字词法元素注释符号分号标识符关键字操作符/运算符和分隔符整型值浮点值虚数值分符值字符串值常量类型方法集布尔类型数值类型字符串类型数组类型分片类型结构体类型指针类型函
Go语言规范汇总
Survivalist_Boy的博客
03-25 927
文章目录统一规范篇合理规划目录GOPATH设置import 规范代码风格大小约定命名篇基本命令规范项目目录名包名文件名常量变量变量申明变量命名惯例全局变量名局部变量名循环变量结构体(struct)接口名函数和方法名参数名返回值开发篇包魔鬼数字常量 & 枚举结构体运算符函数参数返回值注释错误其他参数传递注意闭包的调用优化篇质量保证代码质量保证优先原则对外接口原则值与指针（T/*T）的使用原则...
解决：使用VS开发Go时，Go扩展安装失败
qq_45827558的博客
04-12 5980
报错信息 Installing github.com/nsf/gocode FAILED Installing github.com/uudashr/gopkgs/cmd/gopkgs SUCCEEDED Installing github.com/ramya-rao-a/go-outline FAILED Installing github.com/acroca/go-symbols FAILED Installing golang.org/x/tools/cmd/guru FAILED Installi
Golang编码规范
Webben
12-23 1401
文章目录1. 前言1.1. 一般信息【重要必读】1.2. 如何使用本编程规范1.3. 说明2. 语言规范2.1 true/false 求值2.2 Receiver2.3 类型申明2.4 Error Handler2.5 自定义类型的String循环问题2.6 Typical Data Races-数据竞争2.7 引用第三包需要验证2.8 字符串使用注意事项2.9 embedding 的使用2.10 完善单元测试和性能测试2.11 业务需要梳理接口IO消耗3. 风格规范3.1 Go
golang代码规范
weixin_44911248的博客
05-01 981
golang代码规范 1.go fmt 和go imports 格式化：所有的代码都需要用gofmt格式化。 换行：一行代码不超过120列 括号和空格：运算符和操作数之间要留空格；作为输入参数或者数组下标时，运算符和运算数之间不需要空格 import:使用 go imports自动格式化引入的包名 2.error处理 error作为函数的返回值，必须对error进行处理，或者将返回值赋值给明确忽略 error作为函数的值返回且有多个返回值的时候，error必须是最后一个参数 错误描述不需要标
GO开发规范
Enzo
03-19 1966
GO开发规范 开发环境 Visual Code 与微软开发的专用 Go 插件:VS Code + Go Jet Brains 出的专用 IDE:Goland GOPATH 项目目录应该位于 $GOPATH/src 下。 项目专用的 GOPATH 设置可以使用软链技术来实现: $ echo $GOPATH /tmp/gopath $ pwd xxx/project $ ln -s `pwd`...
GOLANG 1.9 语言规范
李兵的专栏
08-30 1827
简介 本文是GO语言的使用手册。对于更多的信息，请前往 golang.org。 GO 语言是一门通用的系统编程语言。它是一种强类型语言，支持自动垃圾收集，并且对语言层面对并发编程进行了支持。GO 程序以包的形式进行组织，对程序间的依赖关系进行高效的管理。当前实现方式使用传统的编译/链接模型生成二进制可执行文件。 GO语言语法紧凑且规范，故而便于如集成开发环境这样的自动化工具对其进行分析。
[代码规范]Go语言编码规范指导
qfliweimin的博客
04-22 547
本规范旨在为日常Go项目开发提供一个代码的规范指导，方便团队形成一个统一的代码风格，提高代码的可读性，规范性和统一性。本规范将从命名规范，注释规范，代码风格和 Go 语言提供的常用的工具这几个方面做一个说明。该规范参考了 go 语言官方代码的风格制定。 一、 命名规范 命名是代码规范中很重要的一部分，统一的命名规则有利于提高的代码的可读性，好的命名仅仅通过命名就可以获取到足够多的信息。 Go...
Golang2-new.docx
02-18
个人学习golang笔记，从各种教程中总结而来，作为入门参考。目录如下 目录 1. 入门 1 1.1. Hello world 1 1.2. 命令行参数 2 2. 程序结构 3 2.1. 类型 4 2.1.1. 命名类型（named type）与未命名类型（unamed type） 4 2.1.2. 基础类型（underlying type） 4 2.1.3. 可赋值性 5 2.1.4. 类型方法集 6 2.1.5. 类型声明 6 2.2. 变量 8 2.2.1. 变量声明 8 2.2.2. 类型零值 12 2.2.3. 指针 13 2.3. 赋值 17 2.4. 包和文件 17 2.5. 作用域 18 2.6. 语句 19 2.7. 比较运算符 20 2.8. 类型转换 21 2.9. 控制流 23 2.9.1. If 23 2.9.2. Goto 24 2.9.3. For 25 2.9.4. Switch 25 2.9.5. break语句 31 2.9.6. Continue语句 31 3. 基础数据类型 31 3.1. golang类型 31 3.2. Numeric types 32 3.3. 字符串 33 3.3.1. 什么是字符串 33 3.3.2. 字符串底层概念 35 3.3.3. 获取每个字节 38 3.3.4. Rune 39 3.3.5. 字符串的 for range 循环 40 3.3.6. 用字节切片构造字符串 41 3.3.7. 用rune切片构造字符串 42 3.3.8. 字符串的长度 42 3.3.9. 字符串是不可变的 42 3.3.10. UTF8（go圣经） 43 3.4. 常量 45 3.4.1. 常量定义 45 3.4.2. 常量类型 46 3.4.3. Iota 46 4. 组合数据类型 47 4.1. 数组 47 4.1.1. 数组概述 47 4.1.2. 数组的声明 49 4.1.3. 数组的长度 50 4.1.4. 遍历数组 50 4.1.5. 多维数组 51 4.2. 切片 52 4.2.1. 什么是切片 52 4.2.2. 切片概述 55 4.2.3. 创建一个切片 55 4.2.4. 切片遍历 57 4.2.5. 切片的修改 58 4.2.6. 切片的长度和容量 60 4.2.7. 追加切片元素 62 4.2.8. 切片的函数传递 65 4.2.9. 多维切片 66 4.2.10. 内存优化 67 4.2.11. nil slice和empty slice 69 4.2.12. For range 70 4.3. 结构 71 4.3.1. 什么是结构体？ 71 4.3.2. 结构体声明 73 4.3.3. 结构体初始化 77 4.3.4. 嵌套结构体（Nested Structs） 81 4.3.5. 匿名字段 82 4.3.6. 导出结构体和字段 84 4.3.7. 结构体相等性（Structs Equality） 85 4.4. 指针类型 86 4.5. 函数 87 4.6. map 87 4.6.1. 什么是map 87 4.6.2. 声明、初始化和make 89 4.6.3. 给 map 添加元素 91 4.6.4. 获取 map 中的元素 91 4.6.5. 删除 map 中的元素 92 4.6.6. 获取 map 的长度 92 4.6.7. Map 的相等性 92 4.6.8. map的排序 92 4.7. 接口 93 4.7.1. 什么是接口？ 93 4.7.2. 接口的声明与实现 96 4.7.3. 接口的实际用途 97 4.7.4. 接口的内部表示 99 4.7.5. 空接口 102 4.7.6. 类型断言 105 4.7.7. 类型选择（Type Switch） 109 4.7.8. 实现接口：指针接受者与值接受者 112 4.7.9. 实现多个接口 114 4.7.10. 接口的嵌套 116 4.7.11. 接口的零值 119 4.8. Channel 120 4.9. 类型转换 120 5. 函数 120 5.1. 函数的声明 121 5.2. 一个递归函数的例子（ recursive functions） 121 5.3. 多返回值 121 5.4. 命名返回值 121 5.5. 可变函数参数 122 5.6. Defer 123 5.6.1. Defer语句介绍 123 5.6.2. Defer使用场景 128 5.7. 什么是头等（第一类）函数？ 130 5.8. 匿名函数 130 5.9. 用户自定义的函数类型 132 5.10. 高阶函数（装饰器？） 133 5.10.1. 把函数作为参数，传递给其它函数 134 5.10.2. 在其它函数中返回函数 134 5.11. 闭包 135 5.12. 头等函数的实际用途 137 6. 微服务创建 140 6.1. 使用net/http创建简单的web server 140 6.2. 读写JSON 144 6.2.1. Marshal go结构到JSON 144 6.2.2. Unmarshalling JSON 到Go结构 146 7. 方法 146 7.1. 什么是方法？ 146 7.2. 方法示例 146 7.3. 函数和方法区别 148 7.4. 指针接收器与值接收器 153 7.5. 那么什么时候使用指针接收器，什么时候使用值接收器？ 155 7.6. 匿名字段的方法 156 7.7. 在方法中使用值接收器 与 在函数中使用值参数 157 7.8. 在方法中使用指针接收器 与 在函数中使用指针参数 159 7.9. 在非结构体上的方法 161 8. 并发入门 162 8.1. 并发是什么？ 162 8.2. 并行是什么？ 162 8.3. 从技术上看并发和并行 163 8.4. Go 对并发的支持 164 9. Go 协程 164 9.1. Go 协程是什么？ 164 9.2. Go 协程相比于线程的优势 164 9.3. 如何启动一个 Go 协程？ 165 9.4. 启动多个 Go 协程 167 10. 信道channel 169 10.1. 什么是信道？ 169 10.2. 信道的声明 169 10.3. 通过信道进行发送和接收 169 10.4. 发送与接收默认是阻塞的 170 10.5. 信道的代码示例 170 10.6. 信道的另一个示例 173 10.7. 死锁 174 10.8. 单向信道 175 10.9. 关闭信道和使用 for range 遍历信道 176 11. 缓冲信道和工作池（Buffered Channels and Worker Pools） 179 11.1. 什么是缓冲信道？ 179 11.2. 死锁 182 11.3. 长度 vs 容量 183 11.4. WaitGroup 184 11.5. 工作池的实现 186 12. Select 188 12.1. 什么是 select？ 188 12.2. 示例 189 12.3. select 的应用 190 12.4. 默认情况 190 12.5. 死锁与默认情况 191 12.6. 随机选取 191 12.7. 这下我懂了：空 select 191 13. 文件读写 191 13.1. GoLang几种读文件方式的比较 197 14. 个人 197 14.1. ++，-- 198 14.2. 逗号 198 14.3. 未使用的变量 199 14.4. Effective go 199 14.4.1. 指针 vs. 值 199 14.5. 可寻址性-map和slice的区别 201 14.5.1. slice 201 14.5.2. map 202 14.6. golang库 203 14.6.1. unicode/utf8包 203 14.6.2. time包 205 14.6.3. Strings包 205 14.6.4. 输入输出 212 14.6.5. 正则处理 224 14.6.6. Golang内建函数 226

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值