命名规范

文件夹

小写+单数

文件名

小写+下划线+单数

模块引用顺序

config < msg < adapter = data < command = app = msg_send < msg_process < msg_pool < main

文件内

• 使用 """""" 来说明文件
• 使用 # TODO 来标注
• 使用 Black 处理代码

导入顺序

非项目在前，项目在后，按照长短排序

常量

• 大写，下划线
• 导入语句下方

变量

• 小写，下划线
• 全局变量放在常量下方
• 初始化变量放在最下方

类

• 大写+驼峰

函数

• 小写+下划线
• 使用名、名、名、动的形式
• 统一将文件名放在最前面

函数内

• 定义不写返回值
• 每个函数用""""""写注释

yaml

• yaml 中的值均加引号用 str(键默认 str)