高质量编程简介及编码规范
本篇将介绍Go语言的高质量编程以及Go语言编码规范。 编写高质量的代码对于团队合作和开发效率至关重要。高质量的代码应该易于阅读和理解,使其他团队成员能够清楚地了解代码的功能和作用。这样,他们可以放心地进行重构、代码优化和新增功能的开发,而不用担心出现意外情况。
1.高质量编程:编写的代码能够达到正确可靠,简沽清晰的目标可称之为高质量代码。 各种边界条件是否考点完备。 异常情况处理,稳定性保证。 易读易维护。
2.编程原则:实际应用场景千变万化,各种语言的特性和语法各不相同,但是高质量编程遵循的原则是相通的。编写高质量代码实际上可以遵循一个统一的原则:保证代码的简单性、可读性,提高团队生产力。
简单性
消除“多余的复杂性”,用最简单清晰的逻辑编写代码。 不理解的代码无法修复改进。
可读性
代码是写给人看的,而不是机器。 编写可维护代码的第一步是确保代码可读。
生产力
编程更多的是团队合作,因此团队整体的工作效率非常重要。
3.编码规范:
代码格式:
推荐使用 Gofmt 自动格式化代码。 Gofmt:Go 语言官方提供的工具,能自动格式化 Go 语言代码为官方统一风格,常见 IDE 都支持方便的配置。 Goimports:也是 Go 语言官方提供的工具,实际等于 Gofmt 加上依赖包管理,自动增删依赖的包引用、将依赖包按字母序排序并分类。
注释:
注释应该解释代码作用。 注释应该解释代码如何做的。 注释应该解释代码实现的原因。 注释应该解释代码什么情况会出错。
命名规范:
变量的命名:简洁胜于冗长。缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写。变量距离其被使用的地方越远,需要携带的信息就需要越多。 函数的命名:函数名不必携带包名的上下文信息。函数名需要尽可能地简短。当函数返回类型与包名相同时,可以省略类型信息。 包的命名:包名仅由小写字母组成。包名简短且包含一定的上下文信息。不要与标准库问名。