用途:这是一份代码质量指南,服务于生产级数据库项目,核心原则是正确性至上,宁可崩溃也不损坏数据。适用于编写或审查 Rust 代码时参照。
正确性规则:禁止使用绕过性临时方案;处理所有错误并检查不变量;频繁使用断言,绝不静默失败或吞掉边界情况;若无效状态危及数据完整性则直接崩溃,不在未定义状态下继续;考虑边界情况,因为时间足够长后所有可能的 bug 都会发生。
Rust 模式:让非法状态无法表示;使用穷尽式模式匹配;优先用枚举而非字符串/哨兵值;尽量减少堆分配;编写对 CPU 友好的代码,微秒已算很长。
If 语句:仅当两个分支都是预期路径时才使用 if-else。若某分支不应被命中,应使用 assert!、return Err(...) 或 unreachable!,而不是静默忽略。
注释:除 rust SAFETY 注释外,不添加代码注释。
避免过度设计:只做直接请求或明显必要的改动;不添加超出要求的功能;不给未改动代码加文档字符串或注释;不为不可能场景加错误处理;不为一次性操作创建抽象;三行相似代码优于过早抽象。
索引变更:涉及索引插入、删除或冲突解决时,务必对照 SQLite 核对顺序,顺序错误会导致索引不一致且容易遗漏。同时需理解 IO 模型(异步 IO 模型)。
清理:彻底删除无用代码;不留向后兼容 hack(如重命名的 _vars、重导出、// removed 注释)。
单次使用辅助函数:若某辅助函数在单一用例之外无意义,应将其移入调用它的函数内部。