这是我参与「第五届青训营 」伴学笔记创作活动的第3天

一、课程内容

• 高质量编程简介
• 编码规范

二、详细知识点

1、编程原则

简单性

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

可读性

• 代码是写给人看的，而不是机器
• 编写可维护的代码的第一步是确保代码可读

生产力

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

2、编码规范

注释

公共符号始终要注释

代码格式

gofmt

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

goimports

Go语言官方提供的工具，实际等于gofmt加上依赖包管理，自动增删依赖的包引用、将依赖包按字典序排序并分类

命名规范

变量

• 简洁胜于冗长
• 缩略词全大写，当其位于变量开头且不需要导出时使用全小写
• 变量距离其被使用的地方越远，则需要携带越多的上下文信息

函数

• 函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
• 函数名尽量简短
• 当名为foo的包某个函数返回类型Foo时，可以省略类型信息而不导致歧义
• 当名为foo的包某个函数返回类型T时(T 并不是Foo)， 可以在函数名中加入类型信息

包

• 只由小写字母组成。不包含大写字母和下划线等字符
• 简短并包含一定的上下文信息，例如schema、task等
• 不要与标准库同名。例如不要使用sync或者strings
• 不使用常用变量名作为包名。例如使用bufio而不是buf
• 使用单数而不是复数。例如使用encoding而不是encodings
• 谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比format更加简短

三、课程总结

通过这节课，学会了高质量编程的定义和原则，在之后的大项目中也应当遵循上述规则来编写代码，提高代码质量。