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

高质量编程

高质量代码

编写的代码能够达到正确可靠,简洁清晰的目标,可以称之为高质量代码

我们编写的代码,最终都是由人来维护的,但是人的记忆力是有限的,有时我们在编写代码时,能够清晰其中的调用关系和逻辑判断,但是过了一段时间后再来阅读,如果代码质量不高,将会增加开发成本,因此编写的代码质量要达到一定规范,才能够减少阅读以及二次开发的成本.

代码格式

Goland提供了gofmt 和 goimports 工具自动格式化代码,可以在设置里开启,或者使用CTRL+SHIFT+L一键格式化代码,很方便

注释

注释在开发的时候有着至关重要的作用,假设一大段代码完全没有注释,可能开发人员在开发的时候能够捋顺逻辑关系,但是过了一段时间后再来看这段代码,可能就会看得云里雾里,需要联系上下文才能够看懂,而此时已经耗费了不少的时间,而注释能够让我们快速捋顺代码逻辑,而且好的注释在团队开发的时候能够减少团队开发成本,提高效率.

命名规范

1.小写字母开头的变量或者方法,只在包内使用 2.命名应该在保证不出现歧义的前提下尽量简洁,函数名不携带包名的上下文信息 例如HTTP包下,实现同一个功能,server()方法就比serverHTTP()更加简洁, 3.包名由小写字母组成,不要包含大写字母和下划线等 4.不要与标准库同名,会导致歧义

流程控制

应该尽量避免流程嵌套

// Bad
if foo {
    return x
} else {
    return nil
}

// Good
if foo {
    return x
}
return nil

上面的代码不易于二次开发,如果后续还要再加逻辑判断,会导致else if 条件判断增多,代码可读性差 下面的代码在二次开发时,增加判断时可以单独在下面新增一个if来判断,优化代码