知识卡片
示例也是文档
内容
Go 示例代码既可被测试,也可作为包文档展示用法。发散:能运行的示例比自然语言说明更不容易过期。
参考来源
- 位置:《Go语言实战》第9章《测试和性能》(源文件:_epub-src/OEBPS/Text/part0019.xhtml)
- 结论依据:原文围绕“使用示例代码来给包写文档”给出定义、机制、流程、对比或限制条件,本卡片据此提炼可迁移的 Go 语言/工程结论,并补充边界或实践启发。
- 原始内容:第9章 测试和性能 本章主要内容 编写单元测试来验证代码的正确性 使用httptest来模拟基于HTTP的请求和响应 使用示例代码来给包写文档 通过基准测试来检查性能 作为一名合格的开发者,不应该在程序开发完之后才开始写测试代码。使用Go语言的测试框架,可以在开发的过程中就进行单元测试和基准测试。和……