《团队-科学计算器-代码设计规范》

代码布局设计

缩进

  A、   使用四个空格来进行缩进

  B、   换行的时候可以使用反斜杠,最好的方法是使用园括号,在使用反斜杠的时候,在反斜杠的后直接回车,不能有任何空格存在

字符串引导:

  在对于字符串的标示中,使用双引号还是单引号是没有区别的,主要就是两者混合使用从而避免反斜杠的出现。

命名规范:
使用单独的小写字母(b)

使用单独的大写字母(B)

使用小写字母(lowercase)

使用小写字母和下划线(lower_case_with_underscores)

使用大写字母(UPPERCASE)

使用大写字母和下划线(UPPER_CASE_WITH_UPPERCASE)

驼峰式写法(CamelCase):在使用缩写的时候,大写优于小写例如HTTPServer优于HttpServer

首字母大写,然后使用下划线是一种丑陋的写法

1 、避免使用的名称
在写变量的时候,尽量避免小写的l和大写字母O和大写字母I,主要原因是容易和数字中1,0相混淆

2 、包和模块名称
模块尽量使用简短的全部小写的名称,如果可以增加可读性那么可以使用下划线,python的包不推荐使用下划线,但是在引用其他语言写的扩展包中可以使用下划线来表示区分

3 、类名称
类名称主要遵循为CapWords约定,表示为首字母大写

4、异常名称

异常归于类,从而也要遵循类名的规范,主要是在后缀上必须添加“Error“

5全局变量名
全局变量只在模块类有效,和function命名相同

6、方法名称
方法名称全部为小写,下划线是可选的(在增加可读性的基础上使用)

7、方法变量
类的方法第一个参数总是self

类方法的静态变量总是为crs

如果一个方法的参数和保留字相冲突,那么在后面添加下划线进行区分

8、常量
常量命名全部使用大写,可以使用下划线进行分割

注释

在修改的代码的时候,务必修改注释。

注释必须是英文,最好是完整的句子,首字母大写

分别为:行注释,块注释,文档注释

posted @ 2017-09-26 21:19  Brian-hui  阅读(185)  评论(0编辑  收藏  举报