Flask 编码风格

Flask 编码风格

---

1. 代码布局

• 缩进 （不使用tab）

• 每行最大长度 (84字符)

• 长语句换行 （"\" , ".","{}","（）"）

• 空行

2.表达式和语句

• 单目运算符之间无空格

• 双目运算符之间有空格

不能编写尤达语句 ：应该拿变量与常量进行比较

• 任意类型之间比较，用“==”和“!=”

• 单例比较，用 is or is not

• 不要与true or false比较

实例检查：isinstance(a,C ),而避免 type(a) is C

3. 命名规范

• 类名称：驼峰法，首字母缩略词保持大写

• 变量名：小写_以及 _ 下划线

• 方法和函数名：小写 _ 以及_ 下划线

• 常量： 大写 _ 以及 _下划线

• 预编译的正则表达式 ： name_re

特殊：

_name :表示私有，受保护的元素，（前导下划线的确会影响从模块中导入名称的方式，不会导入）

_ _ name:表示只有定义混入类时才使用，会导致Python解释器重写属性名称，以避免子类中的命名冲突，双下划线名称修饰对程序员是完全透明的

name_: 一个变量的最合适的名称已经被一个关键字所占用时，用来解决命名冲突

_ _ name_ _:由双下划线前缀和后缀包围的变量不会被Python解释器修改

_ :单下划线，单个独立下划线是用作一个名字，来表示某个变量是临时的或无关紧要的

不要再变量名后面添加下划线进行区分；如果需要使用关键词作为类名，在名称后添加下划线；如果函数需要访问重名内建变量，重新绑定

 

4.文档字符串规范"""

• 只有一行："""XXXXX """ 代表结束的""" 在同一行；

• 有多行：""" 单独一行

• 摘要与详细介绍之间空一行

5.注释 #

需要在# 加一个冒号：。