简明python代码规范

简明python代码规范

ID:32847232

大小:37.00 KB

页数:6页

时间:2019-02-16

简明python代码规范_第1页
简明python代码规范_第2页
简明python代码规范_第3页
简明python代码规范_第4页
简明python代码规范_第5页
资源描述:

《简明python代码规范》由会员上传分享,免费在线阅读,更多相关内容在学术论文-天天文库

1、执行本规范使用pylint及对应的配置文件来进行检测,关于pylint的安装和配置见:http://blog.csdn.net/lanphaday/article/details/6089902编码所有的Python脚本文件都应在文件头标上如下标识或其兼容格式的标识:#-*-coding:utf-8-*-设置编辑器,默认保存为utf-8格式。注释业界普遍认同Python的注释分为两种的概念,一种是由#开头的“真正的”注释,另一种是docstrings。前者表明为何选择当前实现以及这种实现的原理和难

2、点,后者表明如何使用这个包、模块、类、函数(方法),甚至包括使用示例和单元测试。坚持适当注释原则。对不存在技术难点的代码坚持不注释,对存在技术难点的代码必须注释。但与注释不同,推荐对每一个包、模块、类、函数(方法)写docstrings,除非代码一目了然,非常简单。格式缩进Python依赖缩进来确定代码块的层次,行首空白符主要有两种:tab和空格,但严禁两者混用。公司内部使用2个空格的tab进行缩进。空格空格在Python代码中是有意义的,因为Python的语法依赖于缩进,在行首的空格称为前导空格

3、。在这一节不讨论前导空格相关的内容,只讨论非前导空格。非前导空格在Python代码中没有意义,但适当地加入非前导空格可以增进代码的可读性。在二元算术、逻辑运算符前后加空格,如:a=b+c“:”用在行尾时前后皆不加空格,如分枝、循环、函数和类定义语言;用在非行尾时两端加空格,如dict对象的定义:d={'key':'value'}括号(含圆括号、方括号和花括号)前后不加空格,如:do_something(arg1,arg2)而不是do_something(arg1,arg2)逗号后面加一个空格,前面

4、不加空格;空行适当的空行有利于增加代码的可读性,加空行可以参考如下几个准则:·在类、函数的定义间加空行;·在import不同种类的模块间加工行;·在函数中的逻辑段落间加空行,即把相关的代码紧凑写在一起,作为一个逻辑段落,段落间以空行分隔;断行尽管现在的宽屏显示器已经可以单屏显示超过256列字符,但本规范仍然坚持行的最大长度不得超过78个字符的标准。折叠长行的方法有以下几种方法:为长变量名换一个短名,如:this._is.a.very.long.variable_name=this._is.anot

5、her.long.variable_name应改为:variable_name1=this._is.a.very.long.variable_namevariable_name2=this._is.another.variable_namevariable_name1=variable_name2s在括号(包括圆括号、方括号和花括号)内换行,如:classEdit(Widget):def__init__(self,parent,width,font=FONT,color=BLACK,pos=POS

6、,style=0):#注意:多一层缩进pass或:very_very_very_long_variable_name=Edit(parent,width,font,color,pos)#注意:多一层缩进do_sth_with(very_very_very_long_variable_name)如果行长到连第一个括号内的参数都放不下,则每个元素都单独占一行:very_very_very_long_variable_name=ui.widgets.Edit(panrent,width,font,col

7、or,pos)#注意:多一层缩进do_sth_with(very_very_very_long_variable_name)在长行加入续行符强行断行,断行的位置应在操作符前,且换行后多一个缩进,以使维护人员看代码的时候看到代码行首即可判定这里存在换行,如:ifcolor==WHITEorcolor==BLACKorcolor==BLUE:#注意or操作符在新行的行首而不是旧行的行尾,上一行的续行符不可省略do_something(color);else:do_something(DEFAULT_

8、COLOR);命名一致的命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可读性,降低维护成本。常量常量名所有字母大写,由下划线连接各个单词,如:WHITE=0xffffffffTHIS_IS_A_CONSTANT=1变量变量名全部小写,由下划线连接各个单词,如:color=WHITEthis_is_a_variable=1不论是类成员变量还是全局变量,均不使用m或g前缀。私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。变量名不应带有类型信息,因

当前文档最多预览五页,下载文档查看全文

此文档下载收益归作者所有

当前文档最多预览五页,下载文档查看全文
温馨提示:
1. 部分包含数学公式或PPT动画的文件,查看预览时可能会显示错乱或异常,文件下载后无此问题,请放心下载。
2. 本文档由用户上传,版权归属用户,天天文库负责整理代发布。如果您对本文档版权有争议请及时联系客服。
3. 下载前请仔细阅读文档内容,确认文档内容符合您的需求后进行下载,若出现内容与标题不符可向本站投诉处理。
4. 下载文档时可能由于网络波动等原因无法下载或下载错误,付费完成后未能成功下载的用户请联系客服处理。