讲师中心 微信公众号
AI工具推荐 视频效率加速

Go语言示例测试怎么写_示例测试规则说明

雨敏同学_9902

雨敏同学_9902

发布时间:2026-01-21 09:47:15

|

1005人浏览过

|

来源于php中文网

原创

示例测试函数名必须以Example开头且无参数无返回值,用于生成文档代码片段并校验输出;需严格匹配// Output:注释内容,不支持testing.T操作,运行需显式指定-run标志。

go语言示例测试怎么写_示例测试规则说明

示例测试函数名必须以 Example 开头

Go 的示例测试(Example test)不是用来验证逻辑正确性的,而是为文档提供可运行的、带输出的代码片段。它会被 go docgodoc 工具自动提取展示,同时也能被 go test 执行并比对输出是否匹配注释末尾的 // Output: 行。

函数名必须严格满足:Example + 可选的驼峰命名(如 ExampleMapMerge),且不能带参数、不能有返回值。否则 go test 会直接忽略它。

  • func Example() {} ✅ 合法,但无意义(没说明是哪个 API 的示例)
  • func ExampleSortKeys() {} ✅ 推荐:清晰对应某个导出函数或类型
  • func exampleSortKeys() {} ❌ 小写开头,不会被识别
  • func ExampleSortKeys(t *testing.T) {} ❌ 有参数,会被跳过
  • func ExampleSortKeys() int { return 0 } ❌ 有返回值,不合法

// Output: 必须紧贴函数体末尾,且内容要完全匹配

示例测试的输出校验非常严格:Go 运行时会捕获 fmt.Println 等标准输出,并与函数体最后一段以 // Output: 开头的注释逐行比对(包括空行和尾部空格)。

常见失败原因不是代码错,而是输出格式没对齐。比如:

立即学习go语言免费学习笔记(深入)”;

func ExampleJoinStrings() {
	fmt.Println(strings.Join([]string{"a", "b", "c"}, "-"))
}
// Output:
// a-b-c
  • 注释中 // Output: 和实际输出之间**不能有空行**(上面例子是合法的)
  • 如果代码里是 fmt.Print("a-b-c")(无换行),而注释写的是 // a-b-c(隐含换行),就会失败 —— 因为 fmt.Print 不输出换行,但 // Output: 默认期望每行末尾有换行符
  • 多行输出时,// Output: 后面的每一行都必须精确对应,包括缩进和空格。例如 fmt.Printf("%q", "hello") 输出 "hello",若注释写成 // "hello" (末尾多一个空格),测试即失败

示例测试不能调用 t.Logt.Error

示例函数签名不含 *testing.T,所以无法使用测试断言或日志。它只允许纯演示:构造输入 → 调用目标 API → 输出结果。

Comprehensive Three.js 3D graphics reference
Comprehensive Three.js 3D graphics reference

详细的 Three.js 3D 图形参考,涵盖场景设置、相机、几何体、材质、光照、动画、控制器、加载器、数学工具和调试。

下载

如果你需要验证中间状态、处理错误分支、或做条件判断,就不是示例测试该干的事 —— 那属于 TestXXX 函数的范畴。

  • ✅ 允许:fmt.Println(json.Marshal(myStruct))
  • ❌ 不允许:if err != nil { t.Fatal(err) }(编译不过)
  • ❌ 不推荐:在示例里写 fmt.Println("error case:", err) 来“演示错误”,因为这会让 // Output: 变得脆弱且偏离文档初衷

真正想展示错误处理?单独写一个 ExampleXXXWithError,并在 // Output: 中明确写出错误字符串,前提是那确实是公开 API 合法且稳定的输出形式。

运行和调试示例测试要用 -run-v

默认 go test 不运行示例测试;必须显式启用:

go test -run ^Example

加上 -v 可看到每个示例是否通过、实际输出是什么、预期输出是什么:

go test -v -run ^Example
  • -run ^Example 是正则匹配,确保只跑示例函数(^ 表示开头,避免匹配到 TestExampleHelper 这类名字)
  • 如果只想跑某一个,比如 ExampleSortKeys,写成 go test -v -run ExampleSortKeys
  • 调试时输出不匹配?先手动运行示例函数(把内容复制到临时 main.go),看真实输出长什么样,再调整 // Output: 注释

别忘了:示例测试文件必须放在和被测代码同一包下,且文件名以 _test.go 结尾,否则 go test 根本不会加载它。

热门AI工具

更多
Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

1955

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2622

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

916

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2939

2025.09.10

python中print函数的用法
python中print函数的用法

python中print函数的语法是“print(value1, value2, ..., sep=' ', end=' ', file=sys.stdout, flush=False)”。本专题为大家提供print相关的文章、下载、课程内容,供大家免费下载体验。

2300

2023.09.27

python print用法与作用
python print用法与作用

本专题整合了python print的用法、作用、函数功能相关内容,阅读专题下面的文章了解更多详细教程。

229

2026.02.03

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

869

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2340

2023.10.25

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

20

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn