Python 语法特点：注释/编写规则/命名规范

Posted 2022-05-05 lelin

1.注释

    1）单行注释     #

    2） 多行注释   前后三个单引号或双引号   ‘’‘  ...  ‘‘‘    """  ..."""

    3）中文编码声明注释

          # -*- coding：编码  -*-

         或  # coding=编码

               若采用UTF-8编码，则设置为urf-8;若使用GBK编码，则使用gbk 或cp936

 

2.代码缩进

    使用冒号区分代码之间的层次。

    四个空格或一个Tab键作为缩进。推荐用4个空格。

   可以在IDE设置快捷键，进行缩进或反缩进。

 

3.编码规则

   PEP8 作为编码规范

   1）每一个import 只导入一个模块，尽量避免一次导入多个模块。

   2）不要在每一行结尾加封号；  也不要用封号把两条命令放到一起。

    3）每行不超过80个字符。若超过则用小括号（）将其分行显示。不推荐反斜线

    4）必要的空行。顶级定义之间空两行，方法定义之间空一行。

    5）运算符两侧，函数参数之间，建议用空格分隔

     6）避免在循环中使用 +  +=  累加字符串。字符串是不可变的，这样做会创建不必要的临时对象。每个字符串加入列表，用join() 连接列表

     7）适当使用异常处理结构提高程序容错性，但不能过多依赖异常处理结构，适当的显示判断还是必要的。

 

4.命名规范

    1）模块名尽量短小，并且全部使用小写字母，可以使用下划线。

    2）包名尽量短小，并且全部使用小写字母，不推荐使用下划线。

    3）类名采用首字母大写格式

    4）模块内部的类使用下划线+Pascal 风格

    5）函数，类的属性和方法的命名规则同模块类似。也是使用小写字母，多个字母用下划线分割

    6）常用命名时全部使用大写字母，可以使用下划线

    7）使用单下划线开头的模块变量或函数是受保护的，在使用from xxx import *语句从模块中导入时，这些变量或函数不能被导入

    8）使用双下划线开头的实例变量或方法时类私有的