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

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

阿宇小哥_3543

阿宇小哥_3543

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

|

299人浏览过

|

来源于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 doc 和 go 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.go 或 urlparse/urlparse_example_test.go 中,不能放在其他包路径下——否则 go doc 找不到,go test 也不执行。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载
  • 推荐拆到单独文件:命名如 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工具

更多
讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

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

WorkBuddy

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

豆包大模型

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

Laper
Laper Hot

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

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

226

2026.02.24

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

133

2026.02.24

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

677

2026.02.24

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

238

2026.02.24

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

497

2026.02.24

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

208

2026.02.24

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

584

2026.02.26

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

245

2026.02.26

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

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

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