• Python 编程规范梳理


    缘由

    由于项目团队中新加入了几名攻城狮, 大家之前的背景各不相同,写出的代码也是“风格迥异”。正所谓:“无规则不成方圆”,因此需要对编程进行必要的规范。

    整体的思路是:依照PEP8 Python 编码规范,并结合自己团队的实际情况来定义一些规则。

    代码编排

    1 缩进。4个空格的缩进(编辑器都可以完成此功能),如果使用nodepad++请不要使用默认的Tab,更不能混合使用Tab和空格。

    2 每行最大长度为80,换行可以使用反斜杠 "",最好使用圆括号。换行点要在操作符的后边敲回车。

    3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。 

    4 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。

     

    文档编排

    1 import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。 

    2 不要一次import中多个库,比如import os, sys不推荐。

    空格的使用:总体原则,避免不必要的空格。

    1 各种右括号前不要加空格。

    2 逗号、冒号、分号前不要加空格。

    3 函数的左括号前不要加空格。如Func(1)。

    4 序列的左括号前不要加空格。如list[2]。

    5 操作符左右各加一个空格,不要为了对齐增加空格。

    6 函数默认参数使用的赋值符左右省略空格。

    7 不要将多句语句写在同一行,尽管语法允许使用";"。

    8 if/for/while语句中,即使执行语句只有一句,也必须另起一行()。

    注释

    注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。

    1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。

    2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x

    3 避免无谓的注释。

    命名规范

    1 模块命名尽量短小,使用全部小写的方式,可以使用下划线。

    2 包命名尽量短小,使用全部小写的方式,不可以使用下划线。

    3 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。

    4 异常命名使用CapWords+Error后缀的方式。

    5 全局变量尽量只在模块内有效,类似C语言中的static。统一定义在一个模块中。

    6 函数命名使用全部小写的方式,可以使用下划线。

    7 常量命名使用全部大写的方式,可以使用下划线。

    8 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。

    9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected。non-public属性前,前缀一条下划线

    参考:

    https://github.com/google/styleguide/blob/gh-pages/pyguide.md

    http://www.runoob.com/w3cnote/google-python-styleguide.html

    https://www.cnblogs.com/haishiniu123/p/7125677.html

  • 相关阅读:
    等值首尾和2012年12月27日
    求质数2012年12月29日
    动态规划之最长公共子序列2012年12月22日,23日
    两数组最短距离2012年12月26日
    支配值数目2012年12月25日
    等值数目2012年12月26日
    最长平台问题(递归算法)2012年12月25日
    最长平台问题2012年12月24日
    筛法求质数2012年12月30日
    线性筛法2013年1月2日
  • 原文地址:https://www.cnblogs.com/atuotuo/p/9569422.html
Copyright © 2020-2023  润新知