实践准备 (必须)
- 克隆 github.com/wolfogre/go… 到本地，保证能够编译运行
- 尝试使用 test 命令，编写并运行简单测试 go.dev/doc/tutoria…
- 尝试使用 -bench 参数，对编写的函数进行性能测试，pkg.go.dev/testing#hdr…
高质量编程
-
编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码
- 各种边界条件是否考虑完备
- 异常情况处理，稳定性保证
- 易读易维护
-
编程原则
-
简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
-
可读性
- 代码是给人看的，而不是机器
- 编写可维护代码的第一步是确保代码可读
-
生产力
- 团队整体工作效率非常重要
-
-
编码规范
-
代码格式
- 推荐使用gofmt自动格式化代码
- gofmt：Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格
- goimports:Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字母序排序并分类
-
注释
-
注释应该做的
- 解释代码作用：注释公共符号
- 解释代码如何做的：注释实现过程
- 解释代码实现的原因：解释代码的外部因素，提供额外上下文
- 解释代码什么情况会出错：解释代码的限制条件
-
公共符号始终要注释
- 包中声明的每个公共的符号：变量、常量、函数以及结构都需要添加注释
- 任何既不明显也不简短的公共功能必须予以注释
- 无论长度或复杂程度如何，对库中的任何函数都必须进行注释
-
命名规范
-
变量
-
简洁胜于冗长
-
缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
- ServerHTTP
- xmlHTTPRequest
-
变量距离其被使用的地方越远，需要携带越多的上下文信息
-
-
函数
- 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现
- 函数名尽量简短
- 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
- 当名为foo的包某个函数返回类型T时，可以在函数名中加入类型信息
-
包
- 只由小写字母组成。不包含大写字母和下划线等字符
- 简短并包含一定的上下文信息。例如schema、task等
- 不要与标准库同名。例如不要使用sync或strings
- 不使用常用变量名作为包名。例如使用bufio而不是buf
- 使用单数而不是复数
- 谨慎使用缩写
-
控制流程
-
避免嵌套，保持正常流程清晰
- 如果两个分支中都包含return语句，则可以去除冗余的else
-
尽量保持正常代码路径为最小缩进
- 优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套
-
-
-
-
