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

92 阅读1分钟

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

编程原则 实际应用场景千变万化,各种语言的特性和语法各不相同 但是高质量编程遵循的原则是相通的 简单性 消除"多余的复杂性”,以简单清晰的逻辑编写代码 ●不理解的代码无法修复改进 可读性 代码是写给人看的,而不是机器 编写可维护代码的第一步 是确保代码可读 生产力 团队整体工作效率非常重要

简洁胜于冗长 ●缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写 例如使用ServeHTTP而不是ServeHttp 使用XML .HTTPRequest或者xmlHTTPRequest ● 变量距离其被使用的地方越远,则需要携带越多的上下文信息 全局变量在其名字中需要更多的上下文信息,使得在不同地方可以轻易辨认出其含义

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