1.编码规范
1)每个import语句只导入一个模块,精良避免一次导入多个模块。如
#推荐写法
import os
import sys
#不推荐写法
import os,sys
2)不要在行尾添加分号";",也不要用分号将两条命令放在同一行,如
#不规范的写法
inf = float(input("please input your height:"));
inf2 = float(input("please input your weight:"));
3)建议每一行代码的字符量不要超过80个,如果要输入表达的内容实在是很多的话,用小括号()将多行内容隐式的连接起来,这里不推荐使用反斜杠 " \ "进行连接,如
#推荐写法
printf("哦嚯嚯或后悔偶或欧有哦吼吼㷒红火吼吼吼吼或ihouh欧尼"
"胡或霍霍.")
#不推荐写法
print("哦嚯嚯或后悔偶或欧有哦吼吼㷒红火吼吼吼吼或ihouh欧尼\
胡或霍霍.")
但是其中有两种情况下除外:
a.导入模块的语句过长;
b.写在注释里面的URL;
4)与其他语言同样的特性
a.使用必要的空行用以增加代码的可读性,一般是在函数或者类的定义的时候空两行,之后再方法定义或者分割某些功能模块的函数之间空一行,如
#类的定义
class Demo(self):
"""主要内容"""
print("这里是主要内容")
print("这里是次要内容")
#balalalallaall
#函数定义
def init(self):
"""函数的功能实现"""
print("laugh!")
def test(self):
"""另一个函数"""
print("cry!")
b.适当的使用异常处理结构提高程序容错性,但不能过多的依赖一场处理结果,适当的添加自己的显式判断。
2.命名规范
1)模块名尽量短小,并且全部使用小写字母,可以使用下划线分割多个字母,如
#实例
game_star
game_stop
game_end
2)包名尽量短小,并且全部使用小写字母。取包的名字就不推荐用下划线,如
#实例
demo.name
demo.addrss
demo.size
3)类的名字采用单词首字母大写的形式,为Pascal风格,在很多语言都在使用,如
#实例
class BorrowBokk(self):
"""定义一个借书的类"""
print("我要借书")
4)在定义模块内部的类的时候使用下划线" _ " 和 Pascal风格,如定义个在借书类下的内部类,如
#实例
class BorrowBokk(self):
"""定义一个借书的类"""
print("我要借书")
class _ BorrowBokk():
"""子类定义"""
5)函数,类的属性和方法的命名规则同模块类似。也是全部使用小写字母
6)常量定义的时候全部采用大写字母,同时结合下划线
7)需要注意的点是,使用单下划线" _ " 开头的模块变量或者函数是受保护的,因此导致在使用 " from xxx import * " 语句的时候 ,这一类自带下划线的函数或者变量不能被导入
8)使用双下划线" _ _ "开头的实例函数或者方法是类私有的,如初始化函数
def __init __():
"""类私有函数属性定义"""
```**