Python使用规范

最近一直在写python脚本,马上开源了,发现里面有很多不规范的使用方法,在这里特别记录:

##编码

  • 统一使用 UTF-8 编码;
  • 导入的包在代码的最前面;
  • 每行代码不宜过长,不要超过120字符;
  • 使用面向对象思想编程,按照功能划分类,按照职责划分方法;

##关于注释

  • 单行文档注释可以使用#标注;
  • 多行可以使用三个双引号"""...""";
  • 关键方法要使用注释,方便维护;

##类和方法

  • 对于一个类,里面有多个方法可以使用_init_()方法来初始化变量,以便该类中各个方法使用;假如接入该类只有一个方法,那么可以忽略_init()方法,直接自定义方法;
  • 方法之间可以不空行,类与类之间要空行;
  • 类的名字使用驼峰命名法,首字母大写;
  • 所有方法,全部使用小写;
  • 私有方法,使用_下划线开头;
  • 常量使用大写;
  • 每个语句执行完可以不加";",但是要注意使用换行