高质量编程| 青训营

77 阅读2分钟

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

需要有:

  • 各种边界条件是否考虑完备.
  • 异常情况处理,稳定性保证.
  • 易读易维护.

的特点.

编程的原则为实际应用场景千变万化,各种语言的特性和语法各不相同,但是高质量编程遵循的原则是相通的.

简单性

消除“多余的复杂性”,以简单清晰的逻辑编写代码. 反之,不理解的代码无法修复改进.

可读性

编写可维护代码的第一步是确保代码可读.

生产力

团队整体工作效率非常重要.

编写高质量GO代码

代码格式

gofmt——GO语言官方提供的工具,能自动格式化GO语言代码为官方统一风格,常见IDE都支持方便配置(推荐).

注释

解释代码作用.

解释代码如何做.

解释代码实现原因.

解释代码什么情况出错.

命名规范

简洁.

缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写.

变量距离被使用地方越远,则需要携带更多上下文信息,全局变量在其名字中需要更多的上下文信息,使得在不同地方可以轻易辨认出其含义.

控制流程

避免嵌套,保证正常流程清晰.

尽量保持正常代码路径为最小缩进.

线性原理,处理逻辑尽量走直线,避免复杂的嵌套分支.

正常流程代码沿着屏幕向下移动.

提升代码可维护性和可读性.

故障问题大多出现在复杂的条件语句和循环语句中.

错误和异常处理