dataGroup python代码规范
1. 代码缩进:
对于每一次缩进使用4个空格。使用括号、中括号、大括号进行垂直对齐,或者缩进对齐。绝对不要用tab, 也不要tab和空格混用。 每行最大长度79,换行可以使用反斜杠。缩进一定要注意,因为windows与linux中Tab是不一样的,所以杜绝使用Tab键,就用4个空格
2. 行注释:
最需要写注释的是代码中那些技巧性的部分. 如果你在下次 代码审查 的时候必须解释一下, 那么你应该现在就给它写注释. ==对于复杂的操作, 应该在其操作开始前写上若干行注释.== 对于不是一目了然的代码, 应在其行尾添加注释。
# We use a weighted dictionary search to find out where i is in
# the array. We extrapolate position based on the largest num
# in the array and the array size and then do binary search to
# get the exact number.
if i & (i-1) == 0: # true iff i is a power of 2
3. 快注释(文档描述):
为模块、函数、类、方法写一些文档描述,有很多行的。
'''
created by JTSuperman
2016.9.11
'''
4. 空格的使用:
按照标准的排版规范来使用标点两边的空格,括号内不要有空格。
good:spam(ham[1], {eggs: 2}, [])
bad:spam( ham[ 1 ], { eggs: 2 }, [ ] )
不要在逗号, 分号, 冒号前面加空格, 但应该在它们后面加(除了在行尾)。
if x == 4:
print x, y
x, y = y, x
5.命名规范:
- 包命名尽量短小,使用全部小写的方式
- 类的命名使用capWords的驼峰方式
- 函数命名使用全部小写的方式,可以使用下划线
- 常量命名使用全部大写的方式,可以使用下划线
- 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls