1.4 KiB
1.4 KiB
DOC-010 形成代码、结果与解释的闭环
分类：示例与教学。级别：核心。本规则是项目写作约定，不是语言语义。
规则
关键示例必须给出预期结果或可观察效果，并解释导致该结果的相关规则。
原因
代码展示形式，结果提供核对点，解释使读者能迁移到自己的输入。
执行方法
- 数值示例写出结果；UI 示例说明内容与排列；失败示例说明诊断或状态。
- 解释只针对本例中的关键关系，不逐行重述明显语法。
- 标明预期效果与真实运行结果的区别；没有运行环境时不要制造测试输出。
改写对照
问题写法：只贴 payable 的函数体，不解释最终金额。
推荐做法：说明两次计算依次得到 90 和 85，第二次依赖第一次的结果。
以上是说明写作差异的项目例子，不新增语言能力。
验收
- 读者可预测例子结果。
- 结果与源码计算一致。
- 效果说明没有被误标为执行日志。
依据与边界
SRC-01、SRC-02、SRC-03、SRC-04。来源页记录观察与分析，本页的执行方法是针对项目的综合建议，不宣称由某一原文逐项规定。