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

Go语言示例函数如何展示 Go语言Example函数编写方法【框架】

浅墨君_8252

浅墨君_8252

发布时间:2026-06-04 16:56:19

|

233人浏览过

|

来源于php中文网

原创

Go Example函数必须以Example开头、无参数无返回值,定义在同包的_test.go文件中,末尾需有顶格// Output:注释并精确匹配fmt.Println输出。

go语言示例函数如何展示 go语言example函数编写方法【框架】

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

Go 的测试框架会自动识别以 Example 为前缀、不带参数和返回值的函数作为文档示例。它不是普通测试,不走 go test 默认执行流,而是由 go test -run=^$ -example=. 或 go doc 触发。

常见错误是加了参数(比如 func ExampleFoo(s string))或写了 return,这会导致 go test -example=. 完全忽略该函数,也不报错——静默失效。

  • Example 后紧跟的标识符需与被说明的导出对象(函数/类型/变量)名一致,如 ExamplePrintln 对应 fmt.Println
  • 若想为类型 Config 写示例,函数名应为 ExampleConfig,而非 ExampleNewConfig
  • 函数体末尾建议用 // Output: 注释块标明预期输出,否则 go test -example=. 不校验结果

如何让 Example 函数真正运行并验证输出

默认 go test 不执行 Example 函数,必须显式启用。最常用的是:

go test -run=^$ -example=.

其中 -run=^$ 排除所有普通测试(避免干扰),-example=. 匹配全部 Example 函数。如果只想跑某个,比如 ExampleParseInt,就写 -example=ParseInt。

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

注意:// Output: 后的内容必须与实际 stdout 完全一致(包括空行、缩进、换行符),否则报 Output does not match。例如:

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

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

下载
func ExampleParseInt() {
    i, _ := strconv.ParseInt("42", 10, 64)
    fmt.Println(i)
    // Output:
    // 42
}

这里末尾的 42 前不能有多余空格,也不能少换行。

Example 函数里不能调用 t.Log/t.Error,但可 panic

Example 函数签名固定为 func ExampleXXX(),没有 *testing.T 参数,因此不能用 t.Log 打印调试信息,也不能用 t.Fatal 中断。任何对 t 的引用都会编译失败。

但可以主动 panic("xxx") 来模拟错误路径,只要最终输出匹配 // Output: 即可。不过更推荐用条件分支+注释说明异常情况,例如:

func ExampleParseInt_error() {
    _, err := strconv.ParseInt("not-a-number", 10, 64)
    if err != nil {
        fmt.Println("error occurred")
    }
    // Output:
    // error occurred
}

Example 函数的可见性与包路径依赖

Example 函数必须定义在要说明的对象所在的同一个包中,且自身必须是导出的(首字母大写)。如果包是 github.com/user/lib,Example 函数就得放在该包的源码里,不能放在外部调用方代码中。

跨包引用时要注意:若 Example 函数里用了其他包的符号(如 json.Marshal),必须确保该包已导入;但不要为了写 Example 而在主逻辑中添加非必要 import——Example 文件可独立存在,Go 允许仅在 _test.go 文件里导入额外依赖。

容易忽略的一点:如果 Example 函数位于 xxx_test.go 文件中,它只能说明同目录下同一包的导出项;若想说明 subpkg.Foo,Example 函数就得放在 subpkg 目录内,命名为 ExampleFoo,且文件名仍为 xxx_test.go。

相关文章

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

豆包大模型

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

DeepSeek

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

墨刀AI
墨刀AI Hot

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

讯飞智作

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

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

AionClaw
AionClaw Hot

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

相关专题

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

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

206

2026.02.24

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

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

113

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 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

457

2026.02.24

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

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

208

2026.02.24

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

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

564

2026.02.26

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

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

225

2026.02.26

PixTV官网入口地址合集
PixTV官网入口地址合集

本专题汇总了 PixTV AI 一站式视频创作平台的官方入口与使用教程。无需下载软件,浏览器直接访问即可使用。平台将剧本、图像、视频、声音与剪辑整合在“无限画布”中,接入 GPT Image 2.5、Seedance 2.5 等头部模型。本专题整理了从新建画布、角色锚定、分镜拆分到视频生成与导出的完整操作指南,助你快速上手 AI 短剧与漫剧创作。

40

2026.10.10

热门下载

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

精品课程

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

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