编码规范 | 青训营笔记

79 阅读2分钟

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

今天的录播课程我们主要学习了两部分内容:高质量编程和性能调优实战。高质量编程又分为编码规范和性能优化建议。

高质量编程定义较为主观,课程内定义的高质量代码为正确性、可靠性、简洁、清晰。要实现高质量的代码,保证代码的清晰可读,我们需要一定的编码规范来达到这个目标。

首先代码格式方面,课程中推荐使用gofmt包进行自动代码格式化,另外也有goimports包可以使用。

编码规范的第一部分为注释规范,注释需要做到的有四点:解释代码内容、解释代码如何做的、解释代码实现的原因、解释代码什么情况下会出错。对于公共符号,需要解释代码作用;对于实现过程,需要解释怎么做的,比如代码中复杂的、并不明显的逻辑;对于脱离上下文后难以理解的代码,可以注释实现原因;注释需要提醒潜在限制条件和无法处理的情况。另外Google Style指南中规定,任何既不明显也不简短的公共功能必须予以注释;无论长度或复杂程度如何,对于库中的任何函数都必须进行注释。实际上,代码是最好的注释。

编码规范的另一方面是命名规范。变量名尽量简洁,缩略词全大写,但当其位语变量开头且不需要导出时使用全小写,根据变量与其使用位置的距离,需要携带不同上下文信息。函数名不需要携带包名信息,金量简短,返回类型与包名相同时可以省去说明,否则需要在函数名中加入类型信息。包名只由小写字母构成,不与标准库同名。

控制流程方面尽量保证正常代码路径为最小缩进;错误与异常处理需要提供信息。