1.6 KiB
1.6 KiB
DOC-012 把边界与失败写在相关规则旁
分类：示例与教学。级别：核心。本规则是项目写作约定，不是语言语义。
规则
成功路径之外，说明读者容易触及的限制和失败类别；不要默默忽略错误。
原因
只有成功例子无法表达完整契约，错误位置决定读者应如何修正理解。
执行方法
- 选择有代表性的数量、类型、根结构或结果状态边界。
- 区分 Preflight 可检查错误与 inflight 中才出现的失败。
- 未确定的错误处理写法说明边界并链接状态页，不随意创造 catch、await 或错误类型。
改写对照
问题写法：错误参数会被忽略，所以不用提。
推荐做法：说明参数数量或类型应被检查；读取缺失与执行失败需要独立表达。
以上是说明写作差异的项目例子，不新增语言能力。
验收
- 边界与相应主题相邻。
- 没有把所有失败称为语法错误。
- 未定处理语法仍保持未定。
具体应用
选择读者容易违反的具体约束，按原因、可观察问题和最小修正解释。尚未规定的错误码与捕获语法保持未定；有意反例使用明确无效的 text 围栏。