Example函数必须以Example开头、无参数无返回值,且需放在同包的_test.go文件中;函数内须调用fmt.Println等输出语句,输出严格匹配// Output:注释后的内容,不可含未导入包或未导出标识符。

Example函数必须以Example开头且无参数无返回值
Go 的 go test -v 会自动识别并执行以 Example 开头、签名为空的函数(即 func ExampleXXX()),用于验证文档示例是否可运行。一旦加了参数、返回值,或名字拼错(比如写成 exampleXXX 或 Example_XXX),它就彻底被忽略——连警告都不会有。
常见错误现象:go test -v 输出里完全看不到你的 Example 函数;go doc 里也查不到对应示例。
-
Example后紧跟的标识符应与被测函数/类型名一致(如测试ParseURL,推荐命名为ExampleParseURL) - 函数体内必须调用
fmt.Println(或类似输出语句),否则会被视为“空示例”而跳过 - 不能引用未导入的包;所有依赖需显式
import,哪怕只是fmt
Example里不能用log.Fatal或os.Exit
示例函数本质是测试的一部分,运行时被 testing 包捕获 stdout 并比对输出。如果用了 log.Fatal 或 os.Exit(1),进程直接退出,测试框架收不到任何输出,结果就是静默失败——看起来像“没跑”,其实是崩在半路。
使用场景:你想演示错误处理路径,比如解析非法 URL 时的行为。
立即学习“go语言免费学习笔记(深入)”;
- 改用
if err != nil { fmt.Printf("error: %v\n", err) } - 避免任何会导致 panic 或 exit 的操作(包括未 recover 的 panic)
- 若真要触发 panic 做演示,得用
defer/recover捕获并打印,否则测试中断
Example输出必须与注释中// Output:严格匹配
Go 文档工具靠 // Output: 这行注释后的内容做字符串比对。多一个空格、少一个换行、大小写不一致,测试就报 Output does not match。
性能影响:无实际运行开销,但匹配失败会导致 go test 报错,阻断 CI 流程。
-
// Output:必须独占一行,前后无空格 - 其后所有行(直到函数结束)都会参与比对,包括空行
- 建议用
fmt.Printf控制格式,避免fmt.Println多加的换行干扰 - 如果输出含不确定内容(如内存地址、时间戳),得提前替换或截断
跨文件Example需注意包作用域和测试文件位置
Example 函数必须放在 _test.go 文件里,且该文件的包声明得和被测包一致(不是 xxx_test)。否则编译器找不到被测符号,或者测试时无法访问非导出名。
容易踩的坑:把 Example 写在 main 包或独立的 example_test.go 里却忘了 import 被测包;或误以为可以访问 unexported 变量。
- 文件名必须含
_test.go(如url_test.go) - 包声明写
package url,不是package url_test - 只能调用导出标识符(首字母大写),内部函数/变量不可见
- 若 Example 需要构造复杂输入,可定义在同文件顶部,但别用
var声明全局状态——每次 Example 是独立执行的










