Go语言Example函数详解与使用方法
2026-05-01 17:50:45
0浏览
收藏
Go语言的Example函数是一种专为生成可执行文档而设计的特殊机制,它要求严格遵循命名规范(func ExampleXXX())、零参数签名、置于同包的_test.go文件中,并通过fmt.Println显式输出示例结果;其核心价值在于既能被go test -run ^Example验证正确性,又能自动集成到go doc和pkg.go.dev的官方文档中,成为兼具测试性与说明性的活文档——但任何细微偏差(如大小写错误、多余参数、非fmt输出或错误包路径)都会导致其彻底失效,因此精准实践是解锁Go生态优质文档体验的关键。

Example函数必须以Example开头且无参数
Go 的 Example 函数不是普通测试,它被 go test 和 godoc 特殊识别,命名和签名错一个字母就完全失效。常见错误是写成 ExampleXxx_test 或带参数如 func ExampleFoo(t *testing.T) —— 这会被当成普通函数忽略,既不运行也不出现在文档里。
实操建议:
Example函数名必须严格以大写Example开头,后接可选的、首字母大写的标识符(如ExamplePrint、ExampleSliceFilter),不能有下划线- 函数签名必须是
func ExampleXXX(),零参数、零返回值 - 必须放在
_test.go文件中,且与待示例的代码在同一个包(不能是xxx_test包) - 如果想为某个函数生成示例,推荐命名成
ExampleFuncName,比如为TrimSpace写ExampleTrimSpace
输出必须通过fmt.Println或fmt.Printf显式打印
godoc 生成文档时,只抓取函数体内调用 fmt.Println 或 fmt.Printf 的输出结果,作为示例的「期望输出」。任何其他方式(比如 log.Print、变量赋值、注释里的伪代码)都不会被识别。
实操建议:
- 最后一行必须是
fmt.Println(或fmt.Printf),且内容要能清晰体现输入→输出逻辑 - 避免多余空行或调试输出,否则文档里会照搬显示,影响可读性
- 如果示例涉及多行输出,用多次
fmt.Println;不要用\n拼接——godoc会把换行转成空格 - 示例:
func ExampleTrimSpace() { s := " hello " fmt.Println(strings.TrimSpace(s)) // Output: hello }注意注释// Output:是可选的,但加上能防止输出意外变更导致测试失败
运行和验证:用go test -run ^Example而不是go test
go test 默认不运行 Example 函数,它们不属于 Test 函数族。不加筛选直接跑,你会看到「no tests to run」,误以为写错了。
实操建议:
- 用正则精准匹配:执行
go test -run ^Example(^确保只匹配开头为Example的函数) - 加
-v查看详细输出:go test -v -run ^Example,能看到每个Example是否通过、实际输出 vs 期望输出是否一致 - 如果写了
// Output:注释但实际输出不符,会报类似example_test.go:12: unexpected output的错误,此时要检查打印内容是否含空格、换行或类型隐式转换(比如fmt.Println([]int{1})输出是[1],不是1) - 注意:Windows 下 PowerShell 可能需改用
go test -run "Example$"避免^被解释为转义
生成文档时godoc已弃用,改用go doc或pkg.go.dev
本地 godoc 命令自 Go 1.13 起不再随安装包提供,强行用旧版或第三方 godoc 工具容易不显示 Example 块。现在标准路径是 go doc CLI 或在线 pkg.go.dev —— 它们原生支持 Example,但依赖函数签名和输出格式完全合规。
实操建议:
- 本地预览:运行
go doc,例如. go doc strings.TrimSpace,确认 Example 块是否出现 - 在线发布前,先去
pkg.go.dev搜索你的模块,看 Example 是否渲染正常(有时缓存延迟,需等几分钟) - 如果 Example 没显示,优先检查:函数名是否拼错、是否在
_test.go中、是否用了fmt打印、// Output:注释是否与实际输出一字不差(包括末尾换行) - 别忘了导出:被示例的标识符(如函数、类型)本身必须首字母大写,否则
go doc不会把它和 Example 关联起来
文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《Go语言Example函数详解与使用方法》文章吧,也可关注golang学习网公众号了解相关技术文章。
CSSactive伪类实现点击反馈效果
- 上一篇
- CSSactive伪类实现点击反馈效果
- 下一篇
- 按钮点击音效实现方法详解
查看更多
最新文章
-
- Golang · Go教程 | 30分钟前 | 标准库 · 浮点数 · Go教程 · Go SetPrec math/big.Float.MinPrec math/big.Float.Prec 尾数精度
- Go math/big.Float.MinPrec 怎样计算当前数值所需的最少尾数位
- 438浏览 收藏
-
- Golang · Go教程 | 49分钟前 | 标准库 · 文件操作 · Go教程 · Go 文件路径 filepath.Abs EvalSymlinks os.File.Name
- Go os.File.Name 怎样获取打开文件对象的路径字符串
- 214浏览 收藏
-
- Golang · Go教程 | 54分钟前 | 标准库 · go · 性能优化 · Go io.Copy 流式写入 io.ReaderFrom bufio.Writer.ReadFrom
- Go bufio.Writer.ReadFrom 怎样高效接收 Reader 数据
- 163浏览 收藏
-
- Golang · Go教程 | 56分钟前 | 标准库 · Go教程 · FLUSH bufio.Reader bufio.Writer Go bufio.NewReadWriter io.ReadWriter
- Go bufio.NewReadWriter 怎样组合读写缓冲器
- 116浏览 收藏
-
- Golang · Go教程 | 56分钟前 | 文件操作 · Go教程 · Go os.OpenFile O_APPEND
- Go os.OpenFile 怎样组合创建、追加和权限标志
- 111浏览 收藏
-
- Golang · Go教程 | 59分钟前 | 标准库 · Go教程 · 文件系统 · 虚拟文件系统 Go io/fs.ValidPath fs.FS Go 路径校验
- Go io/fs.ValidPath 怎样判断文件名是否符合 FS 路径规则
- 261浏览 收藏
-
- Golang · Go教程 | 1小时前 | 标准库 · 字符串处理 · Go教程 · 字符串读取 io.Reader strings.Reader Go strings.NewReader
- Go strings.NewReader 怎样把字符串包装成可读取对象
- 376浏览 收藏
-
- Golang · Go教程 | 1小时前 |
- Go io.TeeReader 怎样把读取内容同步写入另一个 Writer
- 193浏览 收藏
-
- Golang · Go教程 | 1小时前 | 标准库 · 错误处理 · Go教程 · io.Reader 短读 Go io.ReadFull io.ErrUnexpectedEOF 固定长度读取
- Go io.ReadFull 怎样读取固定长度数据并区分短读
- 491浏览 收藏
-
- Golang · Go教程 | 1小时前 | 标准库 · TLS · Go教程 · tls Go crypto/tls CipherSuites CipherSuite 密码套件
- Go crypto/tls.CipherSuites 怎样查看当前支持的密码套件
- 323浏览 收藏
-
- Golang · Go教程 | 1小时前 | 标准库 · 错误处理 · Go教程 · io.Writer 多目标写入 Go io.MultiWriter 日志旁路
- Go io.MultiWriter 怎样把一份写入复制到多个 Writer
- 270浏览 收藏
-
- Golang · Go教程 | 2小时前 | Markdown · Go教程 · Go markdown 文档注释 go/doc/comment Printer.Markdown
- Go go/doc/comment.Printer.Markdown 怎样把文档注释导出为 Markdown
- 418浏览 收藏
查看更多
课程推荐
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
查看更多
AI推荐
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1099次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1094次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1265次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1204次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1050次使用
查看更多
相关文章
-
- Java 性能优化上线清单:从定位、改造到灰度发布
- 2026-06-11 860浏览
-
- Spring Boot 压测验证:Gatling、JMeter 与性能回归门禁
- 2026-06-11 843浏览
-
- Java NMT 非堆内存排查:Direct Buffer、线程栈与 Metaspace 分析
- 2026-06-11 826浏览
-
- Spring Boot 容器内存优化:JVM 堆、非堆与 MaxRAMPercentage
- 2026-06-11 809浏览
-
- Tomcat 连接与线程参数调优:maxThreads、acceptCount 与 KeepAlive
- 2026-06-11 792浏览

