如何做到 clean code?如何保证自己的代码拥有高质量？按照以下法则，你的代码将会像诗一样优雅

开始之前，我们先明白几个概念，有了这个基石，你会了解的更全面

什么是 clean code ，怎么判断自己的代码质量？

"Clean code"（干净的代码）是指易于阅读、理解和维护的高质量代码。它符合软件工程中的最佳实践和编码规范，具有良好的结构、可读性和可维护性。

判断自己的代码质量是否高可以参考以下几个方面：

1. 可读性：代码是否易于理解和阅读？是否有适当的命名和注释？是否遵循一致的代码风格和格式化规则？

2. 可维护性：代码是否容易修改和维护？是否遵循单一职责原则，每个函数或类的功能是否明确？是否有合适的模块化和分层结构？

3. 可测试性：代码是否易于编写和运行测试？是否有适当的单元测试和集成测试覆盖率？

4. 性能和效率：代码是否经过优化，以提高性能和效率？是否避免了不必要的重复计算和资源浪费？

5. 错误处理：代码是否正确处理边界条件和异常情况？是否有适当的错误处理机制和日志记录？

6. 依赖关系管理：代码是否遵循良好的依赖关系管理原则？是否有适当的模块化和解耦，以减少依赖关系和提高代码的可重用性？

什么是 CI/CD 

一句话简单概括，CI/CD 是方便你写完就能够立刻部署的工作流。将以下三个主要动作自动化：

1. 代码审查（检查代码风格、质量和安全性等方面）

2. 功能测试（编译和构建软件、在测试环境进行功能测试、性能测试、安全测试等）

3. 部署到生产环境（如果所有测试都通过了，系统会将应用程序部署到生产环境中）

那么 CI 和我们的 clean code 有什么关系呢？相信大家经常在代码写完就能成功运行时会很有成就感，而往往一次通不过 CI，因为 CI 会对 代码风格、质量、安全性进行检查，从可读性到依赖关系管理统统检查一遍。

此时如果你存在代码耦合度过高，比如一个函数实现两个功能、错误处理不充分、可读性不强等问题时，CI都会报错，然后让你处理。

所以想要更高地提升自己的代码质量，就从一个小目标 ”CI 一次过“ 做起。

说了那么多，我们来看看能够提升自己代码质量的那些要点吧

代码质量提升法则

1. 引用某个包时不要用别名：比如你的 yolo 文件夹中有两个包 A 和 B，B 中的程序需要引用到 A 中的函数，这时请直接 import "B"，而不要 import datagram "B" ，可能你觉得引用包时给它一个它作用的名称很便于观看，但是请不要这样做，这是画蛇添足。 

2. 包按照稳定度排序：正确的包排列顺序应该为 ① 标准库包 ② 第三方包 ③ 自己的包

3. 每个 package 都应该有包注释：A 包中的文件顶部，应该在 package A 之上加上它的注释

4. 文件名采用全小写、允许含有数字、下划线

5. 包名应该与所在目录一致：不要大一统的写为 package yolo（主文件夹）

6. 所有导出的标识符都应该有注释（指名称以大写字母开头的）

7. 使用统一的命名风格：在开始工作前，团队/个人需要确定，函数用什么命名法、变量用什么命名法、常量用什么命名法

8. 函数功能要单一：如果你有一个函数，目的是组合文本并写入文件，不要觉得加上三行代码用于写入文件很方便，请写一个写入文件的函数，然后直接调用它

掌握了这些法则，你写的代码就可以满足

clean code 的标准：可读、低耦合、易维护

        创作不易，本文共一千多字，现在用心写的帖子很少，作为对创作者的鼓励，请点一个免费的赞，这会让楼主更有动力更新，谢谢各位！