高质量编程简介及编码规范1 | 青训营

58 阅读2分钟

Go语言基础

如何用Go编写程序

如何编写更简洁清晰的代码

常用Go语言程序优化手段

熟悉Go程序性能分析工具

了解工程中性能优化的原则和流程

1.高质量编程

1.1高质量编程简介

1.1.1什么是高质量——编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码

各种边界条件是否考虑完备

异常情况处理,稳定性保证

易读易维护

1.1.2 编程原则——实际应用场景千变万化,各种语言的特性和语法各不相同,但是高质量编程遵循的原则是相通的

1.1.2.1 简单性 消除“多余的复杂性”,以简单清晰的逻辑编写代码

不理解的代码无法修复改进

1.1.2.2 可读性 代码是写给人看的,而不是机器

编写可维护代码的第一步 是确保代码可读

1.1.2.3 生产力

团队整体工作效率非常重要

1.2编码规范

1.2.1 如何编写高质量的Go代码

代码格式

注释

命名规范

控制流程

错误和异常处理

1.2.2 公共符号始终要注释

包中声明的每个公共的符号: 变量、常量、函数以及结构 都需要添加注释

任何既不明显也不简短的公 共功能必须予以注释

无论长度或复杂程度如何, 对库中的任何函数都必须进 行注释

1.2.1编码规范代码格式

推荐使用gofmt自动格式化代码

gofmt——Go语言官方提供的工具,能自动格式化Go语言代码为官方统-风格;常见IDE都支持方便的配置

goimports——也是Go语言官方提供的工具;实际等于gofmt加上依赖包管理

注释应该做的:

注释应该解释代码作用

注释应该解释代码如何做的

注释应该解释代码实现的原因

注释应该解释代码什么情况会出错

注释应该解释代码什么情况会出错——适合解释代码的限制条件

公共符号始终要注释

对于公共符号都有注释说明

尽管LimitedReader.Read本身没有注释,但它紧跟LimitedReader结构的声明,明确它的作用