0

0

如何在Golang中编写示例函数作为文档 Go语言Example测试代码规范

P粉602998670

P粉602998670

发布时间:2026-03-09 08:39:11

|

824人浏览过

|

来源于php中文网

原创

go example函数必须以example开头、无参数无返回值、定义在_test.go中,末尾需有顶格// output:注释并精确匹配fmt.println输出。

如何在golang中编写示例函数作为文档 go语言example测试代码规范

Go Example函数必须以 Example 开头且无参数无返回值

Go 的 Example 函数不是普通测试,而是文档示例——它会被 go docgodoc(或 pkg.go.dev)直接渲染成可读代码块,同时被 go test 自动执行验证输出。不满足命名和签名规则,就不会出现在文档里,也不会被运行。

常见错误现象:go test 不报错但没输出;go doc 查不到示例;pkg.go.dev 页面空白。

  • 函数名必须是 Example + 驼峰标识符(如 ExampleMapMergeExampleHTTPHandler),不能带下划线
  • 必须定义在 _test.go 文件中(和 *_test.go 同包)
  • 签名严格为 func ExampleXXX():无参数、无返回值
  • 若想演示某个函数,推荐用 ExampleFuncName;若演示类型用法,用 ExampleTypeName_MethodName(如 ExampleSlice_Append

Example函数末尾必须加 // Output: 注释并匹配真实输出

// Output: 不是注释,是 Go 测试框架的硬性标记——它告诉 go test 从这一行开始,下面的内容是**期望的标准输出**,运行时会捕获 fmt.Println 等实际输出,并逐行比对(含空格、换行)。不写、写错位置、或输出不一致,测试就失败。

使用场景:展示 API 典型调用链、结构体初始化后打印、错误处理分支输出等。

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

letterdrop
letterdrop

B2B内容营销自动化平台,从创意到产生潜在客户的内容的最佳实践和工具。

下载
  • // Output: 必须顶格写,前面不能有空格或其他字符
  • 其后每一行输出必须完全一致(包括末尾换行),fmt.Print 少个 \n 就失败
  • 避免在示例中用 log.Println 或自定义 writer,只用 fmt.Println/fmt.Printf
  • 如果不想输出(比如只做 setup),写 // Output: 后空一行即可
func ExampleParseDuration() {
    d, _ := time.ParseDuration("2h30m")
    fmt.Println(d)
    // Output:
    // 2h30m0s
}

Example函数默认不访问外部依赖,但可手动启用 -test.v 查看实际输出

Go 的 Example 测试默认静默运行,失败才报错。你改了代码但示例输出没更新?或者不确定 // Output: 写得对不对?这时候需要主动“看一眼”真实输出。

性能 / 兼容性影响:无额外开销,-test.v 只影响本地调试,不影响 CI 或文档生成。

  • 运行 go test -v -run ^Example.*$(正则匹配所有 Example)
  • 输出中会显示 “got” 和 “want”,帮你快速定位哪一行不一致
  • 注意:如果示例里用了 os.Exitpanic、或并发未同步(如 goroutine 未 wait),会导致输出不可控甚至挂起
  • 不要在 Example 中读写文件、发起 HTTP 请求——它们不属于文档契约,也难保证环境一致性

跨包 Example 要用 ExamplePackageFunc 并确保导出符号可见

想给 json.Marshal 写示例?不能直接写 ExampleMarshal 在自己的 main 包里——go test 只扫描当前包的 _test.go,且只会绑定到同包导出符号。

正确做法:把 Example 放在目标包的源码目录下(即你维护该包时),或用 Example + 包名前缀来模拟(仅限文档意图,不触发测试)。

  • 真正生效的跨包示例,必须放在被文档化包的 xxx_test.go 中(例如 encoding/json/json_test.go
  • 如果你只是使用者,想写说明性片段,可用 ExampleMyApp_UsesJSON,但它不会绑定到 json 包,也不参与其测试
  • 确保被调用的函数/类型是导出的(首字母大写),否则编译失败:cannot refer to unexported name xxx.yyy
文档示例不是玩具代码,它既是测试用例,也是用户第一眼看到的接口说明书。最容易被忽略的是 // Output: 的换行敏感性和 Example 函数的包归属——写错位置,就等于没写。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

247

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

356

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

214

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

407

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

490

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

200

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

1418

2025.06.17

Go高并发任务调度与Goroutine池化实践
Go高并发任务调度与Goroutine池化实践

本专题围绕 Go 语言在高并发任务处理场景中的实践展开,系统讲解 Goroutine 调度模型、Channel 通信机制以及并发控制策略。内容包括任务队列设计、Goroutine 池化管理、资源限制控制以及并发任务的性能优化方法。通过实际案例演示,帮助开发者构建稳定高效的 Go 并发任务处理系统,提高系统在高负载环境下的处理能力与稳定性。

4

2026.03.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 6.1万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号