基础python规范

一、注释

    合理的代码注释应该占源代码的 1/3 左右，Python 语言允许在任何地方插入空字符或注释，但不能插入到标识符和字符串中间。

    在 Python 中，通常包括 3 种类型的注释，分别是单行注释、多行注释和中文编码声明注释：

• 单行注释：

            Python 中使用井号（ # ）作为单行注释的符号，语法格式为：# 注释内容

 print('hello world')  # 这是一条注释

• 多行注释：

            多行注释通常用来为 Python 文件、模块、类或者函数等添加功能描述等信息，使用三单引号或三双引号作为多行注释符号，同时，也是长字符串符号。

 st = '''
     日照香炉生紫烟，
     遥看瀑布挂前川。
     飞流直下三千尺，
     疑是银河落九天。
 '''

• 中文编码声明注释:

            主要用来解决 Python 2.x 中不支持直接写中文的问题，中文编码声明注释的语法有如下 2 种：

            　　# -*- coding:编码 -*-

            　　或者

           　　 # coding=编码

 # -*- coding: UTF-8 -*-

二、缩进规则

    Python 采用代码缩进和冒号（ : ）来区分代码块之间的层次。

    对于类定义、函数定义、流程控制语句、异常处理语句等，行尾的冒号和下一行的缩进，表示下一个代码块的开始，而缩进的结束则表示此代码块的结束。

    Python 中实现对代码的缩进，可以使用空格或者 Tab 键实现。但无论是手动敲空格，还是使用 Tab 键，通常情况下都是采用 4 个空格长度作为一个缩进量（默认情况下，一个 Tab 键就表示 4 个空格）。

 

三、编码规范

    Python 采用 PEP 8 作为编码规范，下面列出一些常见的编码规则：

        每个 import 语句只导入一个模块，尽量避免一次导入多个模块；

        不要在行尾添加分号，也不要用分号将两条命令放在同一行；

        建议每行不超过 80 个字符，如果超过，建议使用小括号将多行内容隐式的连接起来，而不推荐使用反斜杠进行连接；

        使用必要的空行可以增加代码的可读性，通常在顶级定义（如函数或类的定义）之间空两行，而方法定义之间空一行，另外在用于分隔某些功能的位置也可以空一行；

        通常情况下，在运算符两侧、函数参数之间以及逗号两侧，都建议使用空格进行分隔。

 

四、标识符命名规范

    标识符主要作用就是作为变量、函数、类、模块以及其他对象的名称，命名规则如下：

• 标识符是由字符（A~Z 和 a~z）、下划线和数字组成，但第一个字符不能是数字;

• 标识符不能和 Python 中的保留字相同;

• Python中的标识符中，不能包含空格、@、% 以及 $ 等特殊字符;

• 标识符中的字母是严格区分大小写的;

• 以下划线开头的标识符有特殊含义：

            以单下划线开头的标识符（如 _width），表示不能直接访问的类属性，其无法通过 from...import* 的方式导入；

            以双下划线开头的标识符（如__add）表示类的私有成员；

            以双下划线作为开头和结尾的标识符（如 __init__），是专用标识符；

• Python允许汉字作为标识符，但应避免使用汉字作为标识符；

• 当标识符用作模块名时，应尽量短小，并且全部使用小写字母，可以使用下划线分割多个字母，例如 game_mian;

• 当标识符用作包的名称时，应尽量短小，也全部使用小写字母，不推荐使用下划线，例如 com.mr;

• 当标识符用作类名时，应采用单词首字母大写的形式。例如，定义一个图书类，可以命名为 Book;

• 模块内部的类名，可以采用 "下划线+首字母大写" 的形式，如 _Book;

• 函数名、类中的属性名和方法名，应全部使用小写字母，多个单词之间可以用下划线分割；

• 常量命名应全部使用大写字母，单词之间可以用下划线分割；

 

五、python关键字

    关键字是 Python 语言中一些已经被赋予特定意义的单词，不能用这些保留字作为标识符给变量、函数、类、模板以及其他对象命名。

    使用以下命令查看关键字：

 import keyword
 keyword.kwlist

六、python内置函数

    使用内置函数作为标识符不会报错，但会导致同名函数被覆盖，无法使用。