coding-standard.md 1.16 KB

Coding Standard

本文件记录团队通用编码规范。模块特殊规则放在各模块 AI 仓库或对应补充规范中。

建议至少补充:

  • 命名规范
  • 目录结构规范
  • 日志规范
  • 错误处理规范
  • 配置管理规范
  • 注释规范
  • 兼容性要求

产品风险控制

开发默认遵循 product-risk-control-standard.md。涉及执法、抓拍、校时、速度、上传、升级、配置、存储、稳定性和算法指标的改动,必须先识别风险等级,再编码。

  • 配置文件与程序文件分离管理,程序运行中不得隐式修改关键配置。
  • 日志集中写入指定目录,支持定期清理,不得写入程序目录或系统只读区。
  • 对外部输入、网络异常、视频异常、信号异常、存储异常和断电重启必须有容错处理。
  • 涉及升级的改动必须保持历史配置、数据格式和设备兼容。
  • 禁止将 Flash/EMMC 作为高频业务数据存储介质;涉及存储写入的改动需说明写入频率。
  • 涉及 S/A 级风险的逻辑必须有保护阈值、异常隔离、日志和告警设计。
  • 通信协议里禁止用汉字,涉及编码兼容问题