0

0

如何为自己的Golang包编写Example测试_自动集成到文档

P粉602998670

P粉602998670

发布时间:2026-03-04 09:21:10

|

239人浏览过

|

来源于php中文网

原创

example函数必须以example开头、无参数、无返回值且不以下划线结尾;末尾需有与实际输出完全一致的output:注释;须与被测代码同包;运行用go test -run ^example$,查看文档用go doc。

如何为自己的golang包编写example测试_自动集成到文档

Example 函数必须以 Example 开头且无参数

Go 的 go test 只识别形如 func ExampleXXX() 的函数作为文档示例——不能带参数,不能返回值,末尾也不能加下划线(比如 ExampleXXX_test 是无效的)。常见错误是照搬单元测试写法,加了 *testing.T 参数或用了 Test 前缀,结果 go docgo test -v 都不显示它。

  • 正确写法:func ExampleParseURL() { ... }
  • 错误写法:func ExampleParseURL(t *testing.T) { ... }(带参数)
  • 错误写法:func TestExampleParseURL() { ... }(前缀错)
  • 错误写法:func ExampleParseURL_() { ... }(结尾下划线会忽略)

示例里必须有 Output: 注释块

Go 要求每个 Example 函数体末尾紧跟一段以 Output: 开头的注释,内容需与实际打印输出**完全一致**(包括空行、缩进、换行符),否则 go test 运行时会报 output mismatch 错误。

  • 输出含换行?Output: 后面就得跟空行
  • fmt.Println 打印字符串?注释里得包含那个隐式换行
  • fmt.Print?注释里就不能多换一行
  • 建议在示例末尾加 // Output: ... 之前先跑一遍,复制真实输出粘贴过去
func ExampleParseURL() {
    u := ParseURL("https://example.com/path")
    fmt.Printf("%s %s", u.Scheme, u.Host)
    // Output: https example.com
}

Example 文件要和被测包在同一个 .go 文件或同目录 _test.go

Example 函数必须和它演示的类型/函数处在同一包内。如果你的包叫 urlparse,那么 ExampleParseURL 必须定义在 urlparse/urlparse.gourlparse/urlparse_example_test.go 中,不能放在其他包路径下——否则 go doc 找不到,go test 也不执行。

ChatGPT Writer
ChatGPT Writer

免费 Chrome 扩展程序,使用 ChatGPT AI 生成电子邮件和消息。

下载
  • 推荐拆到单独文件:命名如 urlparse_example_test.go,开头仍是 package urlparse
  • 别写成 package urlparse_test(那是外部测试包,Example 不生效)
  • 如果函数依赖私有字段或方法,就只能放在主包文件里,不能挪去外部测试包

运行和验证:用 go test -run ^Example + go doc

写完别只信编辑器高亮——得真跑起来。默认 go test 不执行 Example,必须显式指定;而文档是否挂载,得靠 go doc 实时看。

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

  • 运行示例测试:go test -run ^Example$^Example$ 确保只匹配函数名,避免误触 ExampleXXXHelper
  • 查看文档效果:go doc urlparse.ParseURL,底下会出现 Examples: 小节
  • Web 查看:godoc -http=:6060 启服务后浏览器打开,效果更直观
  • 注意:修改 Example 后,go doc 不自动刷新,需重启 godoc 或清缓存(实际中常被忽略)
Example 测试真正难的不是语法,而是“输出一致性”——它要求代码执行结果和注释字符串逐字节相等。哪怕多一个空格、少一个换行,go test 就失败,go doc 就不展示。这点和普通测试完全不同,也最容易在 CI 里突然爆出来。

热门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 :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

209

2024.02.23

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

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

243

2024.02.23

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

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

353

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结构体相关大全,想了解更多内容,请阅读专题下面的文章。

428

2025.06.09

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

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

200

2025.06.10

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

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

1274

2025.06.17

Swift iOS架构设计与MVVM模式实战
Swift iOS架构设计与MVVM模式实战

本专题聚焦 Swift 在 iOS 应用架构设计中的实践,系统讲解 MVVM 模式的核心思想、数据绑定机制、模块拆分策略以及组件化开发方法。内容涵盖网络层封装、状态管理、依赖注入与性能优化技巧。通过完整项目案例,帮助开发者构建结构清晰、可维护性强的 iOS 应用架构体系。

3

2026.03.03

热门下载

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

精品课程

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

共32课时 | 5.8万人学习

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号