本文共 525 字，大约阅读时间需要 1 分钟。

代码规范指南

缩进规范

• 使用四空格缩进
• 每行最大长度79个字符

空行规范

• 全局类和函数上方要有两个空行
• 类中的函数上方要有一个空行
• 函数内部不同代码块前要有一个空行
• 避免语句合并使用分号
• 控制语句即使只有一行命令也要另起一行
• 代码尾部有且仅有一个空行

空格规范

• 函数参数间有一个空格
• 列表、元组、字典元素间有一个空格
• 字典冒号后有一个空格
• 注释前有一个空格
• 操作符两边都要有空格，但括号内不需要
• 括号内不需要空格

换行规范

• 通过逻辑拆分控制行长
• 可用小括号封装或直接换行符()

文档规范

• import尽量在文件头部
• 每行导入一个对象
• from import对象应为包或模块

注释规范

• 代码行注释在末尾两个空格前加 #
• 注释开头大写，结尾有标点
• 及时更新注释

文档描述规范

• 用三双引号包裹
• 第一句话说明函数用途
• 细致描述功能
• 包括参数、格式、返回值

命名规范

• 变量全小写，多词下划线
• 私有变量前加双下划线
• 常量全大写，多词下划线
• 函数名全小写，多词下划线
• 类名驼峰命名
• 命名要有意义

代码分解技巧

• 减少重复代码
• 函数粒度细化
• 类属性拆分成单独类
• 模块化组织代码

技术规范参考

• 遵循上述规范编写代码
• 适当使用封装处理长行
• 注重代码可读性
• 持续优化代码风格