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

58 阅读2分钟

主要对编码的格式以及编码的规范进行做笔记,在之后的代码编写中要时刻注意这些细节,遵守代码规范,让自己的代码更加美观,更方便浏览。

1.简介

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

2.编码规范

  • 如何编写高质量的Go代码
  • 代码格式
  • 注释
  • 命名规范控制流程
  • 错误和异常处理 1.2.1编码规范-代码格式

2.1编码规范之代码格式

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

gofmt

  • Go语言官方提供的工具,能自动格式化Go语言代码为官方统一风格
  • 常见IDE都支持方便的配置

goimports

  • 也是Go语言官方提供的工具
  • 实际等于gofmt 加上依赖包管理
  • 自动增删依赖的包引用、将依赖包按字母序排序并分类

2.2编码规范之注释

  • 公共符号始终要注释
    但有一个例外,不需要注释实现接口的方法。具体不要像下面这样做

image.png

  • 包中声明的每个公共的符号:
    变量、常量、函数以及结构都需要添加注释
  • 任何既不明显也不简短的公共功能必须予以注释
  • 无论长度或复杂程度如何,对库中的任何函数都必须进行注释

注意:
1.注释要注释代码的作用
2.注释应该解释代码实现的原因
3.注释应该解释代码什么情况下会出错