高质量编程 | 青训营

67 阅读2分钟

1.1 简介

什么是高质量?

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

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

·易读易维护

编程原则

简单性

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

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

可读性

·代码是写给人看的,而不是机器

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

生产力

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

1.2 编码规范

·代码格式

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

·注释

解释代码作用;

解释代码如何做的;

解释代码实现原因;

解释代码什么时候会出错

· 命名规范

变量命名规范

简洁胜于冗长

缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写。

变量距离其被使用的地方越远,则需要携带越多的上下文信息

函数命名规范

函数名不携带包名的上下文信息,因为包名和函数名总是成对出现的

函数名尽量简短

当名为 foo 的包某个函数返回类型 Foo 时,可以省略类型信息而不导致歧义

当名为 foo 的包某个函数返回类型 T 时 (T 并不是 Foo),可以在函数名中加入类型信息

包命名规范

只由小写字母组成。不包含大写字母和下划线等字符

简短并包含一定的上下文信息。例如 schema、task 等

不要与标准库同名。例如不要使用 sync 或者 strings

以下规则尽量满足,以标准库包名为例:

不使用常用变量名作为包名。例如使用 bufio 而不是 buf

使用单数而不是复数。例如使用 encoding 而不是 encodings

谨慎地使用缩写。例如使用 fmt 在不破坏上下文的情况下比 format 更加简短

· 控制流程

避免嵌套,保持正常流程清晰

尽量保持正常代码路径为最小缩进

·错误和异常处理