代码编写规范

基础来源:

Python增强提案:第8号增强提案(PEP 8)是针对Python语言编订的代码风格指南。采用一致的风格书写出可读性强的代码是每个专业的程序员应该做到的事情,这些在多人协作开发一个项目(团队开发)的时候显得尤为重要。

空格:

1、缩进四个空格
2、每行的字符数不要超过79个字符,表达式过长时的分行,第二行在原行基础上再次缩进四个空格
3、函数和类的定义,代码前后都要用两个空行进行分隔。
4、在同一个类中,各个方法之间应该用一个空行进行分隔。
5、二元运算符的左右两侧应该保留一个空格,而且只要一个空格就好。

标识符命名:

1、变量、函数和属性应该使用小写字母来拼写,如果有多个单词就使用下划线进行连接(大小驼峰原则)。
2、类中受保护的实例属性,应该以一个下划线开头。
3、类中私有的实例属性,应该以两个下划线开头。
4、类和异常的命名,应该每个单词首字母大写。
5、模块级别的常量,应该采用全大写字母,如果有多个单词就用下划线进行连接。
6、类的实例方法,应该把第一个参数命名为self以表示对象自身。
7、类的类方法,应该把第一个参数命名为cls以表示该类自身。

表达式和语句

1、采用内联形式的否定词,而不要把否定词放在整个表达式的前面。例如if a is not b就比if not a is b更容易让人理解。
2、不要用检查长度的方式来判断字符串、列表等是否为None或者没有元素,应该用if not x这样的写法来检查它。
3、就算if分支、for循环、except异常捕获等中只有一行代码,也不要将代码和if、for、except等写在一起,分开写才会让代码更清晰。
4、import语句总是放在文件开头的地方。
5、引入模块的时候,from math import sqrt比import math更好。
6、如果有多个import语句,应该将其分为三部分,从上到下分别是Python标准模块、第三方模块和自定义模块,每个部分内部应该按照模块名称的字母表顺序来排列。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 随着代码量的增加和项目的增大以及项目合理或不合理的迭代,代码会显得冗余和杂乱。良好的代码规范和和规则以及设计良好的...
    大刘阅读 3,280评论 0 4
  • 最近写python对于一些代码规范问题感觉有些地方自己还需要加强,翻阅很多文章,特此奉上官方中文翻译版以便日后查看...
    PeterPZ阅读 8,903评论 0 15
  • 一.注释规范 1.创建类添加类注释 2.属性注释 3.更改对方代码时打上注释 4.创建变量 二.命名规范(驼峰命名...
    SanW阅读 2,635评论 0 0
  • iOS编程规范0规范 0.1前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、可靠、可 测试、高效...
    iOS行者阅读 9,920评论 21 35
  • 介绍 愚蠢的使用一致性是无知的怪物(A Foolish Consistency is the Hobgoblin ...
    slords阅读 6,020评论 0 2