主要内容 #
- 代码书写规范: 缩进, 空格, 空行, 换行, 注释
1. 缩进 #
不要使用tab缩进。
使用任何编辑器写Python时,请把一个tab用4个空格代替。
绝对不要混用tab和空格,否则容易出现 “IndentationError”的错误
该缩进的代码要统一用4个空格,不能一会用2个,一会用3个或4个,否则也会出现“IndentationError”的错误
2. 空格 #
比如:f(a, b), 而不使用f(a,b)
使用[1, 2, 3, 4, 5], 而不使用[1,2,3,4,5]
比如: a = b,而不使用a=b
注:在函数的参数列表或是括号内,操作符两端不需要加空格。
比如: f(a=10), 而不使用 f(a = 10)
3. 空行 #
函数和类的顶上需要空两行
函数内逻辑无关的段落之间空一行
在if/for/while语句中,即使执行语句只有一句,也要另起一行。
例如:
i = 0 summary = 0 def function_add(i, summary): while i <= 100: summary += i i += 1 print('1+2+3+...99+100=', summary )
4. 换行 #
不要把多个语句写在一行
每行代码控制在79字符以内,如果太长,可通过\换行
5. 注释 #
不要写错误的注释,比如:
a = a+1 # a等于a减1
不要写无谓的注释,比如:
a = a+1 # a等于a加1
优先使用英文写注释,英文不好则全部用中文注释,不要混合使用。
对函数、方法的注释需要描述清楚它们的功能,输入参数,返回值。
如果有复杂的算法和实现,也要写清楚。