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

Go语言如何编写一个可作为Example运行的函数?文档化单元测试【指南】

梦明酱_2900

梦明酱_2900

发布时间:2026-07-07 06:19:27

|

160人浏览过

|

来源于php中文网

原创

Go Example函数必须以Example开头,而非Test;它用于文档生成,需满足无参数无返回值、末尾// Output:注释及逐行匹配的标准输出等严格格式要求。

go语言如何编写一个可作为example运行的函数?文档化单元测试【指南】

Go Example函数必须以Test开头还是Example开头?

Go的Example函数必须以Example为前缀,不是Test——后者是单元测试函数,会被go test执行;而Example函数仅用于文档生成和交互式验证,运行需用go test -run=^$ -examples或go doc查看。

常见错误是把Example写成func TestMyFuncExample(),结果go test -v里看不到它,go doc也查不到示例输出。

  • Example函数名后可接驼峰标识(如ExampleParseURL),用于关联对应函数,但非强制
  • 函数必须无参数、无返回值,否则go test -examples会直接忽略
  • 最后一行必须是// Output:注释,其后紧跟期望输出(空行也算输出的一部分)

Example函数里怎么打印才能被正确捕获输出?

Go只捕获fmt.Println、fmt.Printf等标准输出到os.Stdout的内容,且要求输出与// Output:下方内容**逐行完全一致**(含空格、换行符)。

容易踩的坑:用log.Println——它输出到os.Stderr,不会被捕获;或用fmt.Print(不换行)导致末尾缺少\n,比对失败。

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

Go语言(Golang)1.26.0
Go语言(Golang)1.26.0

Go语言(Golang)1.26.0版本官方下载,版本号 1.26.0,适合旧项目维护、兼容性测试和指定版本开发环境搭建。

下载
  • 必须用fmt.Println或fmt.Printf("%v\n", x)确保每行结尾有\n
  • // Output:必须独占一行,且紧贴在函数体结束前,不能有空行隔开
  • 如果示例中调用了可能panic的代码(如json.Unmarshal),需显式recover或保证输入安全,否则Example会运行失败,go test -examples报FAIL
func ExampleHello() {
	fmt.Println("hello world")
	// Output:
	// hello world
}

如何让Example同时作为可运行的独立程序?

Go的Example函数本身不能直接go run,因为它没有main入口。但可以复用逻辑:把核心逻辑抽成导出函数,在Example里调用,再额外写一个main.go调用同一函数。

不要在Example里写func main()——这会导致go test解析失败;也不要复制粘贴逻辑,维护成本高。

  • 将示例逻辑封装为DoSomething()(首字母大写,导出)
  • Example函数只负责调用+输出,保持简洁
  • 新建cmd/example/main.go,import包后调用同一函数,这样既可go run cmd/example,又不影响Example测试
  • 若想一键运行所有Example,可用go run -tags example ./...配合构建tag(需在Example文件顶部加//go:build example)

Example和_test.go里的Test函数怎么协同写文档?

Example展示“怎么用”,Test验证“是否正确”,二者互补但职责分明。一个典型流程是:先写Test保证行为正确,再写Example展示典型用法,最后用go test -examples确认输出稳定。

容易被忽略的是:Example的输出文本一旦写死,就变成契约——后续修改函数行为时,必须同步更新// Output:,否则go test -examples会失败,CI可能卡住。

  • 避免在Example里写复杂初始化(如打开文件、启动HTTP server),它不是集成测试
  • 如果函数返回error,Example中应处理并打印,比如if err != nil { fmt.Printf("error: %v\n", err) }
  • 多个Example覆盖不同场景时(如正常路径/错误路径),每个都需独立// Output:,且不能共用变量名引发作用域冲突

最麻烦的其实是空格和换行——多一个空格、少一个回车,Example就挂。每次改完函数逻辑,别忘了重新跑一遍go test -examples。

热门AI工具

更多
墨刀AI
墨刀AI Hot

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

讯飞绘文

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

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

Laper
Laper Hot

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

AionClaw
AionClaw Hot

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

切问学术

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

DeepSeek

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

豆包大模型

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

WorkBuddy

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

相关专题

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

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

226

2026.02.24

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

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

133

2026.02.24

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

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

657

2026.02.24

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

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

218

2026.02.24

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

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

477

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

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

20

2026.10.16

热门下载

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

精品课程

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

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