testing - 什么是 Go 示例函数？

Question

Go 测试包提到 example functions如:

func Example() { ... }
func ExampleF() { ... }
func ExampleT() { ... }
func ExampleT_M() { ... }

这些的含义和用例是什么？

Answer 1

示例函数是包或函数或您正在记录的其他代码的使用示例。示例函数将以源代码形式包含在生成的 godoc 中(而其他函数则不是)，具有适当的格式，还应用了一些处理，例如，如果示例函数的最后一行包含以下格式的输出:

func ExampleExamples_output() {
    fmt.Println("Hello")
    // Output: Hello
}

指定输出的最后一行将被剥离并在单独的 block 中呈现，如下所示:Example (Output) .

此外，如果提供了输出:运行包的测试套件(例如使用 go test)也会执行示例函数，无需您进一步安排，Go 会将示例函数的输出与最后一个注释行中指定的输出 - 此结果将确定此示例函数作为“测试”是否通过。如果示例函数中没有指定输出，go test 只会编译它，不会执行它。

查看此页面:package godoctricks

还发布了一篇关于示例函数的博客文章:

Testable Examples in Go