持续创作，加速成长！这是我参与「掘金日新计划 · 10 月更文挑战」的第3天，点击查看活动详情
什么是干净代码？
C++ 编程语言的发明者 Bjarne Stroustrup 的这句话清楚地解释了干净代码的含义：
“I like my code to be elegant and efficient. The logic should be straightforward to make it hard for bugs to hide, the dependencies minimal to ease maintenance, error handling complete according to an articulated strategy, and performance close to optimal so as not to tempt people to make the code messy with unprincipled optimizations. Clean code does one thing well.
我喜欢我的代码优雅而高效。逻辑应该直截了当，使 bug 难以隐藏，依赖最小化以方便维护，错误处理根据明确的策略完成，性能接近最佳，以免诱使人们使用无原则的优化使代码混乱。干净的代码能做好一件事。”
用 Python 编写干净代码的模式
命名约定：
命名约定是编写干净代码的最有用和最重要的方面之一。在命名变量、函数、类等时，请使用有意义的名称，这些名称可以揭示意图。这意味着我们更喜欢长的描述性名称而不是简短的模棱两可的名称。
下面是一些例子：
1. 使用易于阅读的长描述性名称。 这将消除编写不必要的注释的需要，如下所示：
2. 使用描述意图揭示名称。 其他开发人员应该能够从名称中找出您的变量存储的内容。简而言之，您的代码应该易于阅读和推理。
3.避免使用模棱两可的速记。 变量应该有一个长的描述性名称，而不是一个容易混淆的短名称。
4. 始终使用相同的词汇。 与您的命名约定保持一致。
当其他开发人员处理您的代码时，保持一致的命名约定对于消除混淆非常重要。这适用于命名变量、文件、函数甚至目录结构。
5. 开始在您的编辑器中跟踪代码库问题。
保持 Python 代码库清洁的一个主要组成部分是让工程师可以轻松地跟踪和查看代码本身的问题。在编辑器中跟踪代码库问题允许工程师：
- 全面了解技术问题
- 查看每个代码库问题的上下文
- 减少上下文切换
- 持续解决技术问题
6. 不要使用幻数。 幻数是具有特殊硬编码语义的数字，出现在代码中但没有任何意义或解释。通常，这些数字以文字形式出现在我们代码中的多个位置。
功能
7. 与您的函数命名约定保持一致。
从上面的变量可以看出，在命名函数时要遵守命名约定。使用不同的命名约定会使其他开发人员感到困惑。
9. 不要使用flags或Boolean flags标志。 Boolean标志是保存Bollean值的变量——真或假。这些标志被传递给一个函数，并由该函数用于确定其行为。
课程：
10.不要添加多余的上下文。 这可以通过在使用类时向变量名添加不必要的变量来实现。
在上面的示例中，由于我们已经在 Person 类中，因此无需为每个类变量添加 person_ 前缀。
结论
编写干净的代码有很多优点：提高软件质量、代码可维护性。
在本文中，您了解了一般的干净代码以及使用 Python 编程语言编写干净代码的一些模式。但是，这些模式也可以在其他编程语言中复制。
最后，我希望通过阅读这篇文章，你已经对干净代码和编写干净代码的一些有用的模式有了足够的了解。
