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

什么是高质量

高质量：编写的代码能够达到正确可靠、简洁清晰的目标可称之为高质量代码优点： 1.各种边界条件是否考虑完备 2.异常情况处理，稳定性保证 3.易读易维护

编码原则： 1.简单性：消除“多余的复杂性”，以简单清晰的逻辑写代码不理解的代码无法修复改进 2.可读性：代码是写给别人看的，而不是机器编写可维护代码的第一步是确保代码可读 3.生产力：团队整体工作效率非常重要

编码规范

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

代码格式

注释

注释应该做的：

1.注释应该解释的代码作用
2.注释应该解释代码如何做的
3.注释应该解释代码实现的原因
4.注释应该解释代码什么情况会出错

公共符号始终要注释:比如结构体的作用

命名规范

变量：
1.简洁胜于冗长
2.缩略词全大写，但当其位于变量开头且不需要导出时，使用全小写
    例如使用ServeHTTP而不是ServeHttp
    使用XMLHTTPRequest或者xmlHTTPRequest
3.变量距离其被使用的地方越远，则需要携带越多的上下文信息
    全局变量在其名字需要更多的上下文信息，使得在不同地方可以轻易辨认出其含义
    
函数：
1.函数名不携带包名的上下文信息，因为包名和函数名总是成对出现的
2.函数名尽量简短
3.当名为foo的包某个函数返回类型为Foo时，可以省略类型信息而不导致歧义
4.当名为foo的某个函数返回类型为T时，可以在函数名中加入类型信息

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

控制流程

1.避免嵌套，保持正常流程清晰

if foo{
    return x
}else{
    return nil
}

if foo{
    return x
}
    return nil

2.尽量保持正常代码路径为最小缩进优先处理错误情况/特殊情况，尽早返回或继续循环来减少嵌套 1.最常见的正常流程的路径被嵌套在两个if条件内 2.成功的退出条件是return nil，必须仔细匹配大括号来发现 3.函数的最后一行返回一个错误，需要追溯到匹配的左括号，才能了解何时会触发错误 4.如果后续正常流程需要增加一步操作，调用新的函数，则又会增加一层嵌套

小结： 1.线性原理，处理逻辑尽量走直线，避免复杂的嵌套分支 2.正常流程代码沿着屏幕向下移动 3.提升代码可维护性和可读性 4.故障问题大多出现在复杂的条件语句和循环语句中

错误和异常处理

1.简单错误

1.简单的错误指的是仅出现一次的错误，且在其他地方不需要捕获该错误
2.优先使用errors.New来创建匿名变量来直接表示简单错误
3.如果有格式化的需求，使用fmt.Errorf

2.错误判定在错误链上获取特定种类的错误，使用errors.As

    if _,err :=os.Open("non-existing");err!=nil{
        var pathError *fs.PathError
        if errors.As(err,&pathError){
            fmt.Println("Failed at path:",pathError.Path)
        }else{
            fmt.Println(err)
        }
    }

3.panic

1.不建议在业务代码中使用panic
2.调用函数不包含recover会造成程序崩溃
3.若问题可以被屏蔽或解决，建议使用error代替panic
4.当程序启动阶段发生不可逆转的错误时，可以在init或main函数中使用panic

4.recover 1.recover只能在被defer的函数中使用 2.嵌套无法生效 3.只在当前goroutine生效 4.defer的语句是后进先出

高质量编程及编码规范|青训营课程笔记

什么是高质量

编码规范