命名规则
- 文件夹: 小写+下划线+单数
- 文件名: 小写+下划线+单数
- YAML 文件: 值均加引号且属性为字符串(键默认字符串)
文件内命名
- 文件说明: 使用 """""" 来说明文件
- 待办: 使用 # TODO 来标注
- 格式化: 使用 Black 处理代码
- 导入顺序: 非项目库在前，项目模块在后，按照长度及字母顺序排序，中间空行
- 常量: 大写，下划线，放在导入语句下方
- 变量: 小写，下划线
- 全局变量放在常量下方
- 初始化变量放在末尾
- 内部变量使用 "__"
- 类: 大写+驼峰
- 函数
- 小写+下划线
- 统一将文件名放在最前面
- 使用名、名、名、动的形式
- 定义不写返回值
- 用""""""写注释
模块引用顺序
- lrobot 中:
- config < msg < adapter = data < command = app = msg_send < msg_process < msg_pool < main
模块导入
- 内部导入(如函数内导入)主要是为了防止循环引用
- 在没有 __init__.py 的文件夹（非包文件夹）中不能用"."来使用相对路径
内部函数
- 主要用于代码结构清晰
- 注意：逻辑多次调用时，内部函数会被多次编译，效率较低