知识卡片
可执行示例连接文档与回归
Example函数以真实代码展示调用,命名把它关联到包或成员;带Output注释时go test还执行并比较标准输出。没有输出注释的示例只编译不执行,编译通过也不证明业务结果正确。短而确定的例子能减少文档腐烂,但外部环境与副作用仍需隔离。
核验(2026-10-26):testing示例规则。
这张卡片看不懂?
这张卡片的反馈已满 10 条,暂时无法继续提交。
已有反馈 · 0 / 10 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- · 查看原书依据
如果示例函数内含有类似上面例子中的// Output:格式的注释
参考来源
- 位置:《Go语言圣经》第11章《示例函数》(来源项目book-sources:extracted/Go语言圣经/_epub-src/ch11-06.html;spine 107,归一字符[633,665))
- 结论依据:原文文档、编译与输出校验三种用途,官方文档明确无Output行为。
- 原始内容:如果示例函数内含有类似上面例子中的// Output:格式的注释