Python编程基本规范
1、命名规范 类:类的名称一般为名词,且以驼峰形式(即每个单词首字母要大写,其余字母小写,单词之间无间隔符号)给出。 函数:一般以动词开头,函数名称要准确、简要地概括本函数的作用。函数名一律小写,如有多个单词,用下划线隔开。 变量:变量取名应有实际含义,尽量避免单个字母如m,n,i,j等,除非该变量无实际业务含义。变量名应小写,如有多个单词用下划线隔开。 常量:所有字母大写,多个单词以下划线隔开。 2、换行 函数之间空一行; 类与类外函数之间空两行; 3、注释 在代码的关键或复杂的地方,应作注释,一看便知的部分无需注释。 4、函数抽象与复用 任何两个实现基本相同的功能的代码块,应考虑将其独立成一个函数,再分别调用。 如两个代码块功能基本相同,但略有出入,则抽象的函数应考虑这种细小的差异,通过对函数设定参数来解决,使之能够适配不同情况。 5、函数耦合 函数功能应尽量单一且独立(即不依赖其他函数),尽量避免多个函数层层依赖,如A->B,B->C,C->D。 使用多个函数应多用组合,少用依赖。即不推荐A->B->C->D,推荐写成A->B,A->C,A->D。 6、是否使用类 简单的程序用Python来实现基本不需要使用类或者说面向对象编程的风格,除非需要用到面向对象的继承功能。 如果只是为了隔离一组函数与另外一组函数,也无需封装成类,写在不同的文件中,用模块来区分即可。 在Python中,类更多地是用作一种复杂的数据结构,即视作一种数据类型。 7、异常处理 复杂或涉及用户输入的程序,应考虑程序的稳健性,使之能够应对异常情况。对可能出现的代码块,如涉及用户输入 、文件读写、数据库操作的代码部分应该加上try...catch。 8、程序效率与代码量 在确保实现功能的情况下,代码应尽量精简且高效,追求简洁之美。