24代码检查规则：python语言案例详解

这是一篇关于24代码检查规则：python语言案例详解的思维导图，提高代码质量，降低修复缺陷和后期护成本。

代码检查规则：python语言案例详解

• 检查规则
  • 提高代码质量，降低修复缺陷和后期维护成本
  • 代码风格规范
    • 程序规模
      • 每行字符不超过120，函数长度不超过120
    • 语句
      • 不需要明确语句表示结尾
      • 禁止分号结束语句
      • 一行只能写一条语句
    • 括号使用
      • 尽量避免冗余的括号
    • 缩进
      • 禁止使用tab缩进，使用四个空格
      • 单行拆成多行时，与首句保持对齐
    • 空行
      • 类或全局函数间相隔两行
      • 类方法之间相隔一行
    • 空格
      • 括号内不添加空格
      • 参数列表或索引或切片的左括号前不应该加空格
      • ，；：前不应该加空格，而是之后
      • 二元运算符前后各加一个
      • 关键字参数或参数默认值得等号前后不加空格
    • 注释
      • 每个文件都要有文件声明
        • 版权声明
        • 功能和用途介绍
        • 修改人和联系方式
      • 用docstring描述模块，函数，类，类方法接口时。docstring用三个”“括起来
      • 对外接口部分必须使用docstring 描述，内部接口视情况而定
        • 功能简介
        • 参数
        • 返回值
        • 可能抛出异常需特殊说明
  • 引用规范
    • 禁止使用from...import..句式直接导入类或函数而应导入库后再调用
    • 每行只导入一个库
    • 按标准库，第三方库，应用程序自有库的顺序排列import
  • 定义规范
    • 变量定义规范
      • 局部变量使用小写字母，单词间使用下划线分割
      • 定义的全局变量必须写在文件开头
      • 常量使用大写字母
    • 函数定义规范
      • 函数的返回值小于等于3
      • 默认参数的定义
        • 整数
        • bool
        • 浮点数
        • 字符串
        • none
    • 类定义规范
  • 异常处理规范
    • 禁止使用双参数形式或字符串形式的语法抛出异常
    • 自定义异常
      • 在模块内定义名为error的异常基类
    • 使用except语句捕获具体的异常
    • 捕获异常时使用as语法
• 编码惯例
  • 让模块即可被导入又可执行
  • in运算符的使用
  • 不使用临时变量交换两个值
  • 用序列构建字符串