• Python代码编写规范


    Python代码编写规范

    编码:

    a)     如无特殊情况,文件一律使用UTF-8编码

    b)     如无需特殊情况,文件头部必须加入#-*-coding:utf-8-*-

    缩进

    a)     统一使用4个空格进行缩进

    引号

    a)     自然语言使用双引号”….”,正则表达式使用原生的双引号r””

    b)     机器标识使用单引号’’

    c)      文档字符串(docstring)使用三个双引号”””…”””

    空行

    a)     模块级函数和类定义之间空两行

    b)     类成员函数之间空一行

    import语句

    a)     import语句应按照顺序排列,每组之间用一个空行分隔

    二元运算符

    a)     二元运算符两边各空一格, = -

    函数的参数列表

    a)     函数的参数列表中’,’逗号之后要有空格

    b)     函数的参数列表中,默认值等号两边不要添加空格

    c)      左括号之后,右括号之前不要加多余的空格

    d)     字典对象的左括号之前不要多余的空格

    换行

    a)     第二行缩进到括号的起始处

    b)     第二行缩进4个空格,适用于起始括号就换行的情形

    docstring

    a)     所有的公共模块,函数,类,方法,都应该写docstring,私有方法不一定需要,但是应该在def后提供一个块注释来说明”””…”””

    注释

    a)     有意义的注释 list #list

    b)     比较重要的注释段,使用多个等号隔开,可以更加醒目,突出重要性

    命名规范

    a)     模块名称尽量使用小写命名,首字母保持小写,尽量不要用下划线(除非多个单词,且数量不多的情况

    b)     类名使用驼峰(CamelCase)命名风格,首字母大写

    c)      函数命名一律小写,如有多个单词,用下划线隔开

    d)     变量名尽量小写,如有多个单词,用下划线隔开

    e)     常量采用全大写,如有多个单词,使用下划线隔开

  • 相关阅读:
    Redis系列(三)-Redis replication 实现主从复制(读写分离)
    Redis系列(二)-Redis的RDB和AOF两种持久化机制
    Redis系列(一)-CentOS7下Redis单机安装+自启动
    vmware安装centos 7,没有ifconfig命令,无法访问网络
    本博客停更
    「杂文」昨日之纯真,明日之坚毅
    OkHttpClient跳过证书验证
    java 获取十个工作日之前或之后的日期(算当天)
    java pdfBox给PDF添加图片水印
    docker pull 提示timeout
  • 原文地址:https://www.cnblogs.com/jiyanjiao-702521/p/9559675.html
走看看 - 开发者的网上家园