Python编码规则

1. 命名规则

1.1 变量名、包名、模块名

    变量名通常有字母、数字和下划线组成,且首字母必须是字母或下划线,并且不能使用python的保留字;包名、模块名通常用小写字母

1.2 类名、对象名

    类名首字母用大写,其他字母采用小写;对象名用小写字母。类的属性和方法名以对象作为前缀,对象通过操作符“.”访问属性和方法。类的私有变量、私有方法以两个下划线作为前缀。

l.3 函数名
 
    函数名通常采用小写,并用下划线或单词首字母大写来增加名称的可读性,导入的函数以模块名作为前缀。


2. 模块导入的规范

    在Python中,如果需要在程序中调用标准库或其他第三方库的类时,需要先使用import或from… import语句导入相关的模块。
 
2.1 import语句

    直接使用“import 模块名”即可

2.2 from…import…语句

    使用from…import…语句导入与import语句导入有所不同,区别是前者只是导入模块中的一部分内容,并在当前的命名空间中创建导入对象的引用;而后者在当前程序的命名空间中创建导入模块的引用,从而可以使用“类名.属性”的方式调用。

3. 使用空行分隔代码


    函数之间或类的方法之间用空行分隔,表示一段新的代码的开始。类和函数入口之间也用一行空行分隔,以突出函数入口的开始。注意:空行也是程序代码的一部分。

4. 正确的注释

    单行注释:说明一行语句的作用,使用“#”加若干个空格开始,以回车作为注释的结束
    块注释:说明一段代码的作用或整个程序文件的功能,段落之间用“#”号分离。或者在注释块开始及结尾部分用三引号标示
    程序的跨平台:#! /user/bin/python
    中文注释的支持:# -*- coding: UTF-8 -*-
    调试程序:注释可以帮助程序员调试程序

5. 语句的分离

    通常一行只写一条语句。

    如果一行写多条语句,就必须使用分号分隔每个语句;

    如果多行写一条语句,就要使用“”作为换行符。

原文地址:https://www.cnblogs.com/doudongchun/p/3694843.html