python规范(常用)
1.命名规范
模块名,包名,普通变量,普通函数:小写字母,单词间以下划线隔开。(模块名,包名一般保持一致)。
常量:全大写,如:MAX_CLIENT。
类名:首字母大写。
示例:
module_name, 模块
package_name, 包
ClassName, 类
method_name, 方法
ExceptionName, 异常
function_name, 函数
GLOBAL_VAR_NAME, 全局变量
instance_var_name, 实例
function_parameter_name, 参数
2.代码规范
① utf-8编码:文件头部加入#--conding:utf-8--标识。
② import:写在文件头部,模块声明之后,按顺序写,每组空一行。
③ 空格:运算符两边空格,参数列表逗号后空格,括号两边不宜空格。
④ 空行:模块级函数和类定义之间空两行;类成员函数之间空一行。
⑤ 换行:第二行缩进在括号的起始处,若从括号处换行则在第一行基础上缩进四个;反斜杠‘\’(行末)换行,当有运算符存在时也应保留在行末。
⑥ 注释:块注释#后空一格;句注释#前应空两格将句子分隔开;在代码关键部分(或比较复杂时)重要的;文档注释以"""开始和结尾,首行不换行,末行必须换行。
注意事项:
① 不能使用python定义过的标识符(称为‘关键字’),如:and , else ,yiled等。必要时可以使用以下命令查询:
import keyword
keyword.kwlist
② 在代码在代码关键部分(或比较复杂时),尽量写注释,可以使用多个等式隔开以突出其重要性。如下
#=========================
#注释内容
#=========================
其它:
常用颜色代码:Black #000000 rgb(0,0,0);Blue #0000FF rgb(0, 0, 255);Red #FF0000 rgb(255, 0, 0);Yellow #FFFF00 rgb(255, 255, 0)。其它见博客十六进制颜色代码对应表:https://blog.csdn.net/TheLittlePython/article/details/79063779。
初次使用博客,想记录学习python的过程,恐多有不足,多多包涵,欢迎纠错指导。
参考内容: