高质量编程与性能调优实战

68 阅读2分钟

高质量编程与性能调优实战

1.1简介

什么是高质量

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

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

编程原则

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

简单性

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

可读性

  • 代码是写给人看的,而不是机器
  • 编写可维护代码的第一步是确保代码可读

生产力

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

1.2 编码规范

如何编写高质量的Go代码

  • 代码格式
  • 注释
  • 命名规范
  • 控制流程
  • 错误和异常处理

推荐使用gofmt自动格式化代码

image.png

注释

  • 注释应该解释代码作用

    • 注释应该解释代码如何做的
  • 注释应该解释代码实现的原因

  • 注释应该解释代码什么情况下会出错

注释应该解释代码作用

  • 适合注释公共符号

image.png

注释应该解释代码如何做的

  • 适合注释实现过程

image.png

注释应该解释代码实现的原因

  • 适合解释代码的外部因素
  • 提供额外上下文

image.png

命名规范

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