高质量编程

1、编程原则

日常开发中我们往往以团队的形式进行，虽然应用的具体场景和语言的特性各不相同，但高质量编程遵循的原则是一致的，因此我们的代码必须保证简单性、可读性和生产力，简单性是指，代码需要消除多余的复杂性，比如说，如果对性能提升没有明显的帮助，应该避免使用过于复杂的算法解决问题，易于理解。可读性和生产力可以通过团队内的编码规范保证，编写可维护代码的第一步是确保代码可读

2、编码规范

1、注释

代码中的任何公共符号始终要注释，也就是包中声明的变量、常量、函数与结构都需要添加注释，同时任何既不明显也不简短的公共功能必须予以注释，同时无论复杂程度如何，任何函数必须添加注释。

注释应当完成以下功能：
1、解释代码作用
2、解释代码实现
3、解释代码什么情况下会出错

2、代码格式

go语言中可以直接使用gofmt自动格式化代码，gofmt是Go语言官方提供的工具，能自动格式化Go语言代码为官方统一风格，可以在常见IDE中配置，此外goimports也官方提供的工具，在gofmt的基础上提供了依赖包管理

3、命名规范

基本的命名规范大概有如下几条：
1、越简洁越好
2、缩略词全大写，但当其处于变量开头且不需要导出时，使用全小写
3、变量距离使用的地方越远，需要越多的上下文信息

4、错误和异常处理

异常处理的原则：
1、对于简单错误，即只出现一次的错误，优先使用errors.New创建匿名变量表示简单错误，需要格式化则使用fmt.Errorf
2、对于复杂错误，需要生成一个错误的跟踪链，在fmt.Errorf中使用%w关键字将错误关联到错误链中 3、recover只能在被defer的函数中使用

总结

通过以上原则，可以编写更友好的代码，有利于提升开发效率

go语言高质量编程 | 青训营笔记