无论是工作还是学习,养成良好的写代码习惯,有标准的代码书写习惯是不但可以给自己加分,更重要的是使自己思路更加清晰,方便回忆自己写的代码,快速查阅、提高效率等,也体现了自己做事认证、踏实、不浮躁的一面。本文就是介绍Python语言常见的基本的书写规范。
本文主要从编码、缩进/空格/空行、命名、注释等几个方面来说书写格式需要注意的地方。
1.编码
如果没有特殊的编码要求,建议在文件头部加一行# -*- encoding: utf-8 -*-
标识,声明文件的编码方式,当然,程序文件的编码要和声明的编码保持一致,使用UTF-8编码。
2. 缩进/空格/空行/换行等基本格式
缩进: 统一使用4个空格进行缩进。通常使用1个Tab键,但Tab键不一定使4 个空格键,所以有时候因此出错。
行宽: 每行代码尽量不超过80个字符,但不是严格要求80字符以内,可略微查过。如果代码过长,说明代码设计不太合理。除此之外也方便于在控制台查看代码以及通过对side-by-side的diff时有帮助。
引号:
- 自然语言字符串一般使用双引号;
- 机器标示使用单引号,例如字典中的key;
- 正则表达式使用原生双引号:
r"..."
; - 文档字符串使用三个双引号:
"""......"""
,例如函数注释,对函数参数、返回值的说明等;
空行:
- 模块级函数和定义类之间空两行
- 类成员函数之间空一行
例如:
class A:
def __init__(self):
pass
def hello(self):
pass
def main():
pass
(函数中可以使用空行分隔出逻辑相关的代码)
空格:
- 在二元运算符两边各空一格
[=,-,+=,==,>,in,is not, and]
# 规范
i = i + 1
submitted += 1
x = x * 2 - 1
hypot2 = x * x + y * y
c = (a + b) * (a - b)
# 不规范
i=i+1
submitted+=1
x = x*2-1
hypot2 = x*x+y*y
c = (a+b)*(a-b)
- 函数的参数列表中,
,
,#
,;
之后要有空格
例如
# 规范
def complex(real, imag):
pass
#不规范
def complex