命名规范
文件名
文件名使用小写(必要时使用下划线),如: hello_world.py
变量名
变量名: 小写+下划线 variable_name
全局变量: g开头 g_variable_name
静态变量: s开头 s_variable_name
类成员变量: _+小写+下划线 _variable_name
常量名: 全大写+下划线 CONST_NAME
函数名与类名
函数名: 小写+下划线 function_name
类私有函数: _+小写+下划线 _function_name
类名: 大驼峰 ClassName
结构规范
符号
引号: 自然语言用双引号,机器语言用单引号
空格: 二元运算符两端应有空格(+,-,*,/,=,>,<,>=,<=,||/or,&&/and等)
,根据运算优先级,低优先级可以没有空格(a+b) * (c+d)
左括号右端和右括号左端不应有空格,函数形参之间要有空格 Function(int a, int b)
形参赋值等号两端不要空格 Function(int a=0)
空行: 顶级定义(函数、类)之间空两行,方法定义之间空一行
包的引用
包:
使用绝对路径
import bs4.Beautifulsoup
不建议:
from bs4 import Beautifulsoup
注释
文档注释(除非很简单否则每一个函数和类都需要):
def read_file(file_name):
"""read txt then output its context"""
pass
缩进和分行
缩进: 四空格,严禁tab
分行(字符过长): 不要使用反斜杠,建议用圆括号
其他
Shebang(需要被直接执行的文件头使用):
\#!/usr/bin/python3
建议使用with打开文件:
with open('file.txt','r'):
pass