P345 · 上下文管理

用具体样例文件说明项目约定

Golden-File Convention Pointers

指向当前可用的范例,说明应遵循的部分、例外和反面做法。

编辑审核

以下示例与示意结果由本站编写,用于说明方法,不是模型实测结果。

使用场景

旧项目新增一个连接器,现有样例不完全一致。教学文件 A 展示当前注册接口,B 展示有上限的重试,旧文件 C 吞掉异常且返回成功;维护说明已确认 C 的结构被替代。你希望继承有效约定,不复制旧缺陷。

具体做法

选择与任务相关的当前样例,分别比较文件结构、状态流、共用设施和错误处理。注明每个样例示范哪项规则、哪些部分不适用。遇到真实冲突查维护决定与调用契约;多数或最旧用法不能证明正确。新连接器按选定规则实现,再对照样例与本次验收检查。

反例

把旧连接器 C 整份复制,连吞掉异常的行为也保留,因为保持风格比核对当前接口重要。

改进写法

为新连接器建立具体约定指针:引用当前 A 的注册接口和 B 的有界重试,说明各自适用部分;依据维护说明标记 C 的布局已替代,吞异常不是应复制的风格。检查新代码的结构、状态、共用设施和错误处理与有效样例及本任务一致。重要冲突先列证据与待决点,不按多数数量推定正确。

为什么这样改

“照项目风格”没有说明该看哪个真实机制。具体范例指针能把抽象要求落实到接口与状态,同时把历史演进、偶然不一致和已知缺陷区分开来。

如何验证

示意规则表列 A→注册、B→重试、C→不再采用的布局和吞异常问题。检查新连接器注册正确、重试有界,失败不会被伪装为成功。

每项规则应能回到当前样例或维护决定;只复制 C 或用多数投票覆盖明确契约,都不通过。

适用边界

范例也会过期,必须核对当前内容与适用环境。来源的比例阈值是其工作流约定,不证明少数模式就是错;必要例外应具名,而不是为了整齐抹掉业务差异。

原文与版本

如何收录这些方法