首页  /  Python教程  /  编码规范  /  

编码规范

点击打开在线编译器,边学边练

本章节我们来讲述一下Python的编码规范,我们来先看一个例子。

201.png    202.png

大家认为以上两个代码,哪个让人看着更为舒适呢?我想大多人会选择右侧,以为它看上去更加整洁,这是一种最基础的代码规范,遵守代码规则和命名规范可以使得代码更加规范化,对代码的理解和维护十分重要。

本节会详细对代码编写规则以及命名规范等进行介绍。

1.编写规则

Python采用PEP 8 的编码规范,接下来会讲解一些我们在学习Python过程应该严格遵守的条目。

●  每个import语句只导入一个模块,尽量避免一次导入多个模块。

例如:

import random
import os
#尽量不要采取下面这种方式,分别导入
import os,random

●  不要在代码末尾加‘;’,也不要用分号将2条命令写在同一行。

例如:

#不规范写法

a=1;
b=1;
c=1;d=1;
#规范写法
a = 1
b = 1
c = 1
d = 1
或者
a = b = c = d = 1

●  建议每行不超过80个字符,如果超过,建议用小括号“()”将多行内容连接起来,而不推荐使用反斜杠‘\’进行连接。

例如:

203.png

●  使用必要的空行可以增加代码的可读性,一般在顶级定义之间空两行,而方法定义之间空一行。

●  运算符两侧和函数参数之间建议使用空格进行分割。

●  应该避免在循环中使用+和+=操作符累加字符串,这是因为字符串是不可变的,这样会创建不必要的临时对象,推荐做法是将每个字符串加入列表,然后循环结束后使用join()方法连接列表。

●  适当使用异常处理结构提高程序容错性,但不能过多依赖异常处理结构。

      2.命名规范

命名规范在代码中起到很重要的作用,尽管不规范命名的程序我们依然可以运行,但是会影响我们更方便的理解代码。

下面来介绍一些命名规范:

●  命名尽量短小并且使用小写字母,可以使用下划线分割多个字母,例如get_name、tom_home、asset,这些都是推荐使用的类型。(本小节存在不遵守此规范的实例,有兴趣的可以找一下)

●  类名采用单词首字母大写的形式,例如,GetMoney,History等

●  使用单下划线“_”开头的模块变量或者函数是受保护的,在使用import*from语句从模块中导入时这些变量或者函数不能被导入。

●  使用双下划线 “__”开头的变量或方法是类私有的。

3. 空格

代码中有些位置是需要空格的,下面是使用空格的规范:

●  赋值符号“=”前后各有一个空格

●  所有的二元运算符都应该使用空格与操作数分开

例如:a += c + d

●  括号内不要有空格,Python中括号包括小括号“0”、中括号“[]”和

●  括号“{}"。

●  不要在逗号、分号、冒号前面有空格。

        4.缩进

4个空格被认为是一个缩进,Python中的缩进类似于C语言中的‘{}’,在‘:’换行后一定要跟一个缩进,不然会出现语法错误。

正确如下图:

204.png

如果不正确使用缩进,就会出现SyntaxError错误。

      5.注释

最后再讲一下注释规则,大家会在本教程中看到很多很多的注释,注释穿插于代码中,‘#’为开始,换行即截止。

      6.总结

本章就讲到这里,良好的编程习惯会帮助你成为一个优秀的开发人员,本章的内容大家可以在之后的学习过程中多多回顾,下一节我们来学习一下标识符和关键字。

其他教程
第一章 人生苦短,我用Python
第二章 Python基础语法
第三章 Python入门语法
第四章 Python核心语法
第五章 函数
第六章
第七章
第八章
第九章
第十章 GUI编程
第十一章 进程和线程
第十二章 数据库管理
第十三章 算法
第十四章 爬虫
第十五章 实战篇
第十六章 后记