高质量编程 1 | 青训营

108 阅读2分钟

目录 

1. 简介

2. 编码规范

1. 简介

编写的代码能够达到正确可靠、简洁清晰的目标 为高质量编程。

简单性:消除“多余的复杂性”,以简单清晰的逻辑编写代码。不理解的代码无法修复改进 。

可读性:代码是写给人看的,而不是机器。编写可维护代码的第一步是确保代码可读。

生产力 :团队整体工作效率非常重要。

2. 编码规范

代码格式:gofmt 是 Go 语言官方提供的工具,能自动格式化 Go 语言代码为官方统一风格 常见IDE都支持方便的配置。goimports 也是 Go 语言官方提供的工具 实际等于 gofmt 加上依赖包管理 自动增删依赖的包引用、将依赖包按字母序排序井分类。

注释:注释应该解释代码作用,注释应该解释代码如何做的 ,注释应该解释代码实现的原因,注释应该解释代码什么情况会出错,公共符号始终要注释。

命名规范:variable ,简洁胜于冗长 缩路词全大写,但当其位于变量开头目不需要导出时,使用全小写。变量距离其被使用的地方越远,则需要携带越多的上下文信息 全局变量在其名字中需要更多的上下文信息,使得在不同地方可以轻易辨认出其含义。function,函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的 ,函数名尽量简短, 当名为 foo 的包某个西数返回类型 Foo 时,可以省略类型信息而不导致歧义, 当名为 foo 的包某个函数返回类型 T 时(T 并不是Foo),可以在函数名中加入类型信息。package,只由小写字母组成。不包含大写字母和下划线等字符 ,简短井包含一定的上下文信息。例如schema、 task 等 不要与标准库同名。例如不要使用 sync 或者 strings 以下规则尽量满足,以标准库包名为例,不使用常用变量名作为包名。例如使用 butio 而不是buf. 使用单数而不是复数。例如使用encoding 而不是 encodings. 谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短。