高质量编程-编码规范之代码格式和注释

news2024/11/23 11:57:07

$\textcolor{Green}{前言：}$

💞这个专栏就专门来记录一下寒假参加的第五期字节跳动训练营
💞从这个专栏里面可以迅速获得Go的知识

本次文章不仅仅是在 go 中主要注意，在编写其他语言中也同样重要。因为我们是一个团队，主张的是团队合作，编写的代码都是给他人看的，我们编写一个好的代码会给他人带来乐感。同时在面试的时候，面试官看到你写的代码岂不是开开心心的。必须写的明明白白的，接下来就一起学习吧。

本文中还有后续等待发布，编码规范远不止这么点，我会加紧更新的。

本次学习的目标：如何编写更简洁清晰的代码

本章内容主要是讲解高质量编程包含以下三个内容

一、高质量编程

1.1 简介

什么是高质量：编写的代码能够达到正确可靠、简洁清晰的目标。

同时还需要考虑到以下情况

编程原则

实际应用场景是千变万化的，尤其是各种语言的特性和语法各不相同。但是高质量编程遵循的原则是相同的。这就是之前和大家说过的，之前使用java过程中也会有高质量编程的规范，所以无论世界怎么变化，原则是不变的。

注意以下几点

简单性
- 消除“多余的复杂性”，以简单清晰的逻辑编写代码
- 不理解的代码无法修复改进
在实际应用过程中，复杂的程序逻辑难以重构和优化。因为无法明确预知调整造成的影响范围。难以理解的逻辑，排查道德问题也很难定位，不知道如何修复。
可读性
- 代码是写给人看的，而不是机器。
- 编写可维护代码的第一步是确保代码可读。
在项目的迭代过程中，后续的工作是对已有功能的完善或扩展，基本上很少完全对某个功能去掉，对应的代码也会存在很长时间。所以一个代码的可读性是非常有必要，否则会占用很多人的时间。
生产力
- 团队整体工作效率非常重要。
我们作为程序猿相信对这个已经不陌生了，讲究的是团队合作，讲究一个工作效率。在 GO 中为了降低新手的上手 Go 的成本，GO 还通过工具强制统一所有代码格式。

整体的编码，所有人遵循规范，可以避免常见缺陷的代码，降低后续测试、验证、上线等各个节点出现的概率，即使出现问题，也可以快速排查定位。

如何编写高质量的 Go 代码

推荐使用 gofmt 自动格式化代码
- 要保证所有的 go 代码与官方推荐格式保持一致。
- gofmt 是 go 语言官方提供的工具，能自动格式化 go 语言代码为官方统一风格。
- 很方便进行配置，像 Golang 内置了相关功能，直接开启就可以在保存文件的时候自动格式化了。常见的 IDE 都支持方便的配置。
goimports
- 这也是 Go 语言官方提供的工具。
- 这个也会对依赖包进行管理，实际等于 gofmt 加上依赖包管理。
- 自动增删依赖的包引用，将依赖包按字母排序分类，具体情况下具体分析。