高质量编程与性能调优实战 | 豆包MarsCode AI刷题

48 阅读3分钟

大家好,今天又来记录一下今天学习的内容

1.高质量编程与编码规范

说实话,这一期视频对我的学习有很大的帮助,因为在自己学习做项目的过程中,对于写注释其实没有那么重视,可能就会将已经写在开发文档的内容,对应的写在代码的最前面起到提示自己的作用,并没有说去考虑给其他人去方便阅读吧。这个视频确实教会了我很多地方,接下来来总结一下我所学到的内容

什么是高质量编程

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

需要考虑的问题

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

编程原则

简单性

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

可读性

  • 写的是让人读懂的
  • 编写可维护代码的第一步是确保代码可以读

生产力

1.编码规范 - 注释
  1. 公共符号始终要注释
  • 应该声明的每个公共的符号:变量,常量,函数以及结构都需要加注释
  • 任何不明显也不简短的公共功能必须予以注释
  • 无论长度或者复杂程度如何,对库中的任何函数都必须进行注释
  • 注释应该做到:
  • 1.解释代码作用
  • 2.应该解释代码如何做的
  • 3.代码实现的原因
  • 4.解释代码什么情况会出错
2.编码格式 - 代码格式

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

gofmt :是 Go 语言官方提供的工具(不是,Java 怎么就没有呢?强烈谴责)

goimports:;实际上等于 gofmt 加上依赖包管理,自动增删依赖的包引用,将依赖包按照字母序排序并分类

3.编码规范 - 命名规范
  • 简洁好于冗余
  • 缩略词全大写,但当其位于变量开头且不需要导出时,使用全小写
  • 例如 ServeHTTP 而不是 ServeHttp
  • 变量距离其使用的距离越远,则需要携带越多的上下文信息
  • 全局变量在名字中需要有更多的上下文信息,使得在不同的地方可以轻易辨认出来

function

  • 函数名字尽量简短
  • 函数名不携带包名的上下文信息,因为包名和函数名总是成对出现

package

  • 只由小写字母组成,不包含大写字母和下划线等字符
  • 简短并且包含一定的上下文信息,例如schema,task
  • 不要与标准库同名,例如不要用 sync 或者 strings

还有

  • 不使用常用变量名作为包名,例如使用bufio 而不是 buf
  • 使用单数而不是复数
  • 谨慎的使用缩写
4.编码规范 - 控制流程

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

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

  • 优先处理错误情况/特殊情况,尽早返回或者继续循环来减少嵌套
  • 最常见的正常流程的路径被嵌套在两个if条件内
  • 成功的退出条件是 return nil,必须仔细匹配大括号来发现
  • 函数最后一行返回一个错误,需要追溯到匹配的左括号,才能了解何时会触发错误
  • 如果后续正常流程需要增加一步操作,调用新的函数则又会增加一层嵌套