示例函数
除了测试和基准测试之外,testing包还提供了一些示例函数,可以用于生成代码示例和文档。
Example函数
Example函数可以用于生成代码示例,以便开发者更好地了解如何使用被测试的代码。
代码语言:javascript复制func ExampleAdd() {
fmt.Println(Add(1, 2))
// Output: 3
}
在这个例子中,我们定义了一个名为ExampleAdd的示例函数,用于演示Add函数的使用方法。在示例函数中,我们调用Add函数,并使用fmt.Println函数输出函数的返回值。在函数的最后,我们使用注释// Output: 3来指定预期的输出结果。
在运行示例函数时,testing包会自动运行函数,并将输出与预期的输出结果进行比较。如果输出与预期结果一致,则示例函数运行成功,否则测试失败。
Example函数和Output注释
在示例函数中,我们可以使用Output注释来指定预期的输出结果,这有助于我们编写更好的示例代码。
代码语言:javascript复制func ExampleAdd() {
fmt.Println(Add(1, 2))
// Output: 3
}
func ExampleSub() {
fmt.Println(Sub(1, 2))
// Output: -1
}
在这个例子中,我们定义了两个示例函数ExampleAdd和ExampleSub,用于演示Add和Sub函数的使用方法。在示例函数中,我们调用相应的函数,并使用fmt.Println函数输出函数的返回值。在函数的最后,我们使用注释// Output:来指定预期的输出结果。
在运行示例函数时,testing包会自动运行函数,并将输出与预期的输出结果进行比较。如果输出与预期结果一致,则示例函数运行成功,否则测试失败。