如何在Go中将示例添加到API文档中



Go标准库中有一些不错的可执行示例。如何将这样的示例添加到我自己的API文档中?

$ go help testfunc:的输出

"go test"命令期望查找测试、基准测试和示例函数在与测试包对应的"*test.go"文件中。

测试函数是一个名为TestXXX的函数(其中XXX是任何字母数字字符串不是以小写字母开头),并且应该有签名,

func TestXXX(t *testing.T) { ... }

基准函数是一个名为BenchmarkXXX的函数,应该具有签名

func BenchmarkXXX(b *testing.B) { ... }

示例函数类似于测试函数,但不是使用*testing.T要报告成功或失败,请将输出打印到操作系统。标准偏差和操作。标准错误。将该输出与函数的"output:"注释进行比较必须是函数体中的最后一个注释(参见下面的示例)。一编译"输出:"后没有此类注释或没有文本的示例但未执行。

Godoc展示ExampleXXX的主体以演示其用途函数、常数或变量XXX的。方法M的一个例子接收器类型T或*T被命名为ExampleT_M。可能有多个例子对于给定的函数、常数或变量,用尾随的_xxx来区分,其中xxx是一个不以大写字母开头的后缀。

下面是一个例子:

func ExamplePrintln() {
Println("The output ofnthis example.")
// Output: The output of
// this example.
}

当整个测试文件包含单个示例函数,至少一个其他函数、类型、变量或常量声明,并且没有测试或基准测试函数。

有关更多信息,请参阅测试包的文档。

最新更新