Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 1.72 KB

codestyle.md

File metadata and controls

45 lines (34 loc) · 1.72 KB

python的代码规范(lbc-joker)

缩进

  • 每个缩进级别使用4个空格。
  • 续行应该使用在括号,方括号和花括号内使用Python的隐式线垂直对齐包装的元素,或使用悬挂式缩进 。使用悬挂式凹痕时,应考虑以下几点:第一行不应包含任何参数,并且应使用进一步的缩进形式将其清楚地区分为延续行:

变量命名

  • 变量名全部小写,由下划线连接各个单词
  • 普通变量:
  • 小写字母,单词之间用_分割
  • 实例变量:
  • 以_开头,其他和普通变量一样

每行最多字符数

  • 限制所有行最多70个字符。

函数最大行数

  • 限制函数行数最多100行。

函数、类命名

  • 类名:
  • 单词首字母大写
  • 函数名:
  • 小写字母,单词之间用_分割

常量

  • 字母全部大写,由下划线连结各个单词

空行规则

  • 两行空行分割顶层函数和类的定义。
  • 类的方法定义用单个空行分割。
  • 额外的空行可以必要的时候用于分割不同的函数组,但是要尽量节约使用。
  • 额外的空行可以必要的时候在函数中用于分割不同的逻辑块,但是要尽量节约使用。

注释规则

  • 单行注释可以单独写一行,也可写在代码行的末尾。
  • 单行注释以#开头跟2各空格再跟#再跟一个空格,然后写注释
  • 多行注释是指三单引号开头三单引号结尾之间的内容,三双引号开头三双引号结尾亦可。不能三- 单引号开头三双引号结尾,也不能三双引号开头三单引号结尾。
  • 多行注释最常用的场合是给类、函数注释说明文档,

操作符前后空格

  • 在二元运算符两边各空一格

其他规则