Python代码检查评审表
|
类别 |
检查项 |
符合 (✓/✗) |
备注 |
|
代码格式 |
不使用分号结束行或分隔同一行的多个语句 |
✓ |
|
|
|
最大行长度 ≤ 80 字符 |
✓ |
|
|
|
使用 4 个空格 缩进(禁用 Tab 键) |
✓ |
|
|
|
顶级定义(函数/类)之间空 2 行 |
|
|
|
|
类内方法之间空 1 行 |
✓ |
|
|
|
括号、冒号、逗号前 无空格,内部也无空格 |
|
|
|
|
删除所有行尾空格 |
|
|
|
注释 |
公共模块、函数、类必须用 """ 编写文档字符串 |
✓ |
|
|
|
文档字符串首行简短描述,空一行后写详细说明 |
|
|
|
|
行内注释以 # + 空格 开头,与代码间隔 2 空格 |
|
|
|
命名规范 |
变量/函数名:lower_case_with_underscores |
✓ |
|
|
|
类名:CapitalizedWords(驼峰式) |
✓ |
|
|
|
常量:ALL_CAPS_WITH_UNDERSCORES |
✓ |
|
|
|
私有成员:单下划线前缀 _private |
✓ |
|
|
|
避免缩写(如 data 而非 dt) |
|
|
|
字符串 |
优先用 f-string(Python 3.6+)格式化 |
|
|
|
|
避免用 + 拼接多字符串 |
✓ |
|
|
数据结构 |
列表/字典优先用推导式 |
|
|
|
|
避免直接使用 map/filter(除非惰性求值) |
|
|
|
类型提示 |
函数参数和返回值添加类型注解 |
✓ |
|
|
|
try 块内代码尽量少 |
|
|
|
性能优化 |
避免在循环内重复计算(如将不变式移出循环) |
✓ |
|

浙公网安备 33010602011771号