什么是 Go 示例函数？

Question

Go 测试包提到了示例函数，如下所示：func Example() { ... }func ExampleF() { ... }func ExampleT() { ... }func ExampleT_M() { ... }这些的含义和用例是什么？

Answer 1

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

func ExampleExamples_output() {

    fmt.Println("Hello")

    // Output: Hello

}

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

此外，如果提供了输出：运行包的测试套件（例如 with go test）也会执行示例函数而无需您进一步安排，并且 Go 将示例函数的输出与最后一条注释行中指定的输出进行比较 - 结果将确定此示例函数是否作为“测试”通过。如果示例函数中未指定输出，go test则只会编译它但不会执行它。