0.3Python 代码编写的规范

一、命名规范

1、包名：全部小写字母，中间可以由点分隔开，不推荐使用下划线。如：com.linux

2、模块名：全部小写字母，如果是多个单词构成，可以用下划线隔开，如model_thread

3、类名：首字符大写，采用驼峰法命名，如connectLinux

4、变量名：全部小写字母，如果有多个单词构成，可以用下划线隔开，如conn_cmd

5、常量名:全部大写字母，如果是多个单词构成，可以用下划线隔开 CONNECTTIME

二、编码要求

1、头文件：文件头部必须加入 # -- coding: UTF-8 --

2、缩进：统一使用 4 个空格进行缩进，每行代码尽量不超过 80 个字符

3、空行：模块级函数和类定义之间空两行，类成员函数之间空一行

4、空格：
1>在二元运算符两边各空一格[=,-,+=,==,>,in,is not, and]
2>函数的参数列表中，,之后要有空格如：
connect(ip, port， user, password)

5、换行：第二行缩进到括号的起始处如：

print(vone, two,
      three, 
     )

6、引号
自然语言使用双引号，如：print（“输出”）
机器标示使用单引号，如字典中的key： dir={‘key’:‘num‘,‘key2’:‘num2‘}
正则表达式 使用原生的双引号 r"…"

三、注释

1、#注释
“#”号后空一格，如：# 注释

2、行注释
至少使用两个空格和语句分开，注意不要使用无意义的注释

3、建议
在代码的关键部分(或比较复杂的地方), 能写注释的要尽量写注释
比较重要的注释段, 使用多个等号隔开, 可以更加醒目, 突出重要性

# ================
# 比较重要内容
# ================

4、文档注释（Docstring）
一般出现在模块头部、函数和类的头部，这样在python中可以通过对象的__doc__对象获取文档,模块、公有类、公有方法, 能写文档注释的, 应该尽量写文档注释。如：

class ConnectLinux:
    """
    类说明：连接服务器类
    输入参数: ip, port, user, passord
    输出参数：
    """
    
	print(result,
	      ConnectLinux.__doc__)