这是我参与「第五届青训营 」伴学笔记创作活动的第 8 天
前言
大家好呀，这是我参加青训营伴学笔记创作活动的第 8 天，如存在问题，烦请各位斧正！
其中有一些关键图片超过了最大字符限制，不能上传了，我都使用特殊标记给它标记出来了，如有需要，请联系我。
高质量编码-编码规范
概述
1、什么是高质量 ————编写的代码能够达到正确可靠，简洁清晰的目标
1）各种边界条件是否考虑完备
2）异常情况处理，稳定性保证
3）易读以维护
2、编程原则
（1）简单性 （2）可读性 （3）生产力
代码格式
<图片超过最大字符限制>
注释
1）注释应该解释代码作用
2）注释应该解释代码如何做的
3）注释应该解释代码实现的原因
4）注释应该解释代码什么情况会出错
5）公共符号始终要注释
（1）包中声明的每个公共的符号：变量、常量、函数以及结构
（2）任何极不明显也不简短的公共功能必须予以注释
（3）无论长度或复杂程度如何，对库中的任何函数都必须进行注释
（4）例外：不需要注释实现接口的方法
命名规范
1、变量名
1）简洁胜于冗长
2）缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
（1）例如使用 ServerHTTP 而不是 ServerHttp
（2）使用 XMLHTTPRequest 或者 xmlHTTPRequest
3）变量距离其被使用得到地方越远，则需要携带越多的上下文信息
比如全局变量在其名字中需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
4）举例：在一个for的嵌套内，迭代最好使用i而不是index，因为全称index也没有增加对程序的理解。
但是一个入参deadline不可以替换为t，因为deadline可以加深阅读此函数之人对程序的理解。
2、方法
1）函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的。
比如http包下的Server方法，不必命名为ServerHTTP方法。
2）函数名尽量简短。
3）当名为foo的包某个函数返回类型Foo 时，可以省略类型信息而不导致歧义。
4）当名为foo 的包某个函数返回类型丁时（T并不是Foo)，可以在函数名中加入类型信息。
3、包
1）只由小写宇母组成。不包含大写宇母和下划线等字符。
2）简短并包含一定的上下文信息。例如schema、task 等。
3）不要与标准库同名。例如不要使用sync或者strings。
4）以下规则尽量满足，以标准库包名为例：
（1）不使用常用变量名作为包名。例如使用bufio而不是 buf
（2）使用单数而不是复数。例如使用encoding 而不是encodings
（3）谨慎地使用缩写。例如使用fmt在不破坏上下文的情况下比 format更加简短
控制流程
1）线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支。
（1）避免嵌套，保持正常流程清晰：
错误例子：
if(){ 语句1 }else { 语句2 } 正确例子：if(){ 语句1 } 语句2（2）尽量保持正常代码路径为最小缩进，即尽可能少的有if或for的嵌套
2）正常流程代码沿着屏幕向下移动，即别回溯、如goto。
3）提升代码可维护性和可读性。
4）故障问题大多出现在复杂的条件语句和循环语句中。
异常处理
1）error尽可能提供简明的上下文信息链，方便定位问题。
2）panic用于真正异常的惰况，若问题可以被屏蔽或解决，建议使用 error代替panic。
3）recover生效范围：在当前goroutine的被defer的函数中生效。
性能优化建议
概述
1）性能优化的前提是满足正确可靠、简洁清晰等质量因素。
2）性能优化是综合评估，有时候时间效率和空间效率可能对立。
3）针对Go语言特性，介绍Go相关的性能优化建议。
Benchmark
1、背景：性能表现需要实际数据衡量，Go语言提供了支持基准性能测试的benchmark工具。
2、使用：
go test -bench=. -benchmem3、结果说明：
<图片超过最大字符限制>
常用数据结构优化
1、slice切片
1）预分配内存：尽可能在使用make() 初始化切片时提供容量信息
2）在已有切片基础上创建切片，不会创建新的底层数组。
原底层数组在内存中有引用,得不到释放，可使用copy替代re-slice。
2、map
它也有扩容操作，建议根据实际需求提前预估好需要的空间，这样可以减少内存拷贝和Rehash的消耗。
3、字符串
Go字符串同样不可变。拼接时，尽量少用"+"，
多使用
strings.StringBuilder和bytes.Buffer，他俩性能相近，Buffer能更快一些。4、空结构体
1）空结构体struct{}实例不占据任何的内存空间。
2）可作为各种场景下的占位符使用，能节省资源。
空结构体本身具备很强的语义，即这里不需要任何值，仅作为占位符。
3）应用：比如使用map实现set，value可以使用空结构体：
m := make(map[string]struct{})
性能调优实战-性能分析工具pprof
1、性能调优原则
1）要依靠数据不是猜测
2）要定位最大瓶颈而不是细枝末节
3）不要过早优化 |以及| 不要过度优化
2、pprof
1）pprof是用于可视化和分析性能分析数据的工具：
比如希望知道应用在什么地方耗费了多少CPU、Memory
