golang 示例测试example_testing - 运行并验证示例

testing - 运行并验证示例

testing 包除了测试，还提供了运行并验证示例的功能。示例，一方面是文档的效果，是关于某个功能的使用例子；另一方面，可以被当做测试运行。

一个示例的例子如下：

func ExampleHello() {

fmt.Println("Hello")

// Output: Hello

}

如果 Output: Hello 改为：Output: hello，运行测试会失败，提示：

got:

Hello

want:

hello

一个示例函数以 Example 开头，如果示例函数包含以 "Output" 开头的行注释，在运行测试时，go 会将示例函数的输出和 "Output" 注释中的值做比较，就如上面的例子。

有时候，输出顺序可能不确定，比如循环输出 map 的值，那么可以使用 "Unordered output" 开头的注释。

如果示例函数没有 "Output" 注释，该示例函数只会被编译而不会被运行。

命名约定

Go 语言通过大量的命名约定来简化工具的复杂度，规范代码的风格。对示例函数的命名有如下约定：

包级别的示例函数，直接命名为 func Example() { ... }

函数 F 的示例，命名为 func ExampleF() { ... }

类型 T 的示例，命名为 func ExampleT() { ...