如何在 Go 中编写示例测试？

从现在开始，我们要努力学习啦！今天我给大家带来《如何在 Go 中编写示例测试？》，感兴趣的朋友请继续看下去吧！下文中的内容我们主要会涉及到等等知识点，如果在阅读本文过程中有遇到不清楚的地方，欢迎留言呀！我们一起讨论，一起学习！

我正在编写一个测试框架，并希望将示例放入我的文档中。为了可维护性，我想测试这些示例，但我不知道如何测试。

理想情况下，我想要一个经过测试的示例，如下所示：

func testfoo(t *testing.t) {
    f := mytestframework.fromt(t)
    // code using f
}

将上面的代码片段包装在 func examplefoo() { } 中不起作用，因为函数定义不能嵌套（这是一个语法错误）。

我尝试将其放入单独的 example_test.go 文件中，但是 godoc 会将其误认为是测试文件，如 go.dev 博客中的整个文件示例（强调我自己的）：

A whole file example is a file that ends in _test.go and contains exactly one example function, no test or benchmark functions, and at least one other package-level declaration.

我查看了 go 的文档包的文档，但我不知道这对我是否有用。

我可以将示例作为 markdown 代码块粘贴到文档中的某个位置，但是这样就不会经过测试，并且将来可能会悄然过时。

有什么方法可以测试示例测试，或者至少进行类型检查？

正确答案

按照设计，testing 包不支持使用 * 的可执行示例测试.t。目前根据定义，整个文件示例不得包含 test* 函数。

最好的选择是将示例代码作为缩进块添加到包或函数文档中。这就是 testing 包的方式提供示例文档

// using test framework:
//
//      func testfoo(t *testing.t) {
//          framework(t)
//      }

另一种选择是使用 example 函数并将测试函数声明为匿名函数

func ExampleTesting() {
    _ = func(t *testing.T) {
        framework(t)
    }
}

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《如何在 Go 中编写示例测试？》文章吧，也可关注编程网公众号了解相关技术文章。