Python的编码规范（超详细）

---

一、前言

编码的规范性对代码的整体展现有着较大的影响。
先让我们看两张规范与不规范的代码截图来感受下。
先让我们看看不规范的吧。

看完有什么感觉吗？或许你会没有感觉，在让我们来看看我自认为很规范的做下对比。（有疑问可以评论，有时间我会回复的）

将两张图片进行下。如果是你，你喜欢前面的代码还是喜欢后面的代码呢？

---

二、编写规范

python中采用 PEP8 （python 增强建议书） 作为编码规范。
PEP8具体地址：
https://peps.python.org/pep-0008/
我列举了些必要的编码规范，希望对你有帮助。

注：记得点击每条规则后的小数字查看注脚。

1.不要在每行和末尾加分号“ ；”，也不要通过分号将两条命令放在一行上。¹

2.每行的字符不要太长。建议用“（）”进行隐式连接，而不推荐用反斜杠“\”进行连接。²

3.必要的空行可以增加代码的可读性。³

4.运算符/逗号等两侧进行空格。⁴

5.适当的使用异常处理结果提高程序的容错性。⁵

---

三、命名规范

命名规范在编写代码起到了非常重要的作用。
毕竟是规范，不用也可以，但是对于代码的理解或许会很难。代码大多数时候不是给你自己看的。所以改有的还得有。
1.模块名尽量短小，并且全部小写字母，可以使用下划线连接多个单词。例如：value、game_value等。(value是我经常用的一个单词)
2.包名尽量短小，并且全部使用小写字母，不推荐使用下划线。例如：box.top、game、fun等。
3.类名采用首字母大写形式（Pascal风格）。例如一个战斗机类—FighterPlane。
4.模块内部的类采用下划线“_”+Pascal 风格 的类名组成。例如，在战斗机类—FighterPlane 中新建一个内部类，制空战斗机—AirSuperiorityFighter(有时候也想简短，但臣妾做不到呀！)
5.函数、类的属性和方法的命名规范和模块相似，也是全部采用小写字母，单词间采用下划线“_”分隔。
6.使用双下划线“__”开头的实例变量或方法是私有的。

四、结语

这篇文章就这些了。感谢大家的阅读。如果感觉不错的话就给作者一个三连。
谢谢！

---

1. python不同于其他编程语言，不需要用分号“ ；”将代码段分开。python的每一行就代表了一句代码。 ↩︎

2. 我们可以将较长的代码用“（）”将其隐式的链接起来。
   
   不推荐用反斜杠“\”连接。
   ↩︎

3. 通常在定义函数/类等情况下空两行，而方法定义和不同功能的代码块之间空两行。
   看下效果图：
   ↩︎

4. 例图：
   
   从中可以看出我只在“and”间进行了空格，没有在“==”和“=”两边空格。这是因为“==”和“=”两边空格有时没有必要。
   让我们来看看在它们两边加上空格后的样子。
   
   下面这张的效果就不是很好了，特别是if语句那行。所以，不是一定要空格的，不仅要注意可读性，还要考虑整体展现的效果。毕竟规矩是死的，人是火的。 ↩︎

5. 异常处理语句也就是try语句。可以用但不能过于依赖。 ↩︎