2015-03-19 32 views
8

转到测试包提到example functions为:什么是Go示例函数?

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

的含义是什么,并使用情况对这些?

+0

我什么也看不到不清楚您链接到文档。国际海事组织,你的问题等同于“规范提到'int'这是什么意思和用例呢?”即如此模糊/基本或没有真正的问题,因为没用。 – 2015-03-19 16:05:23

+1

@ icza的回答是现货。该文档没有提到该示例函数与'godoc'一起使用,所以我不清楚你会使用它们。 – Calin 2015-03-19 16:21:26

回答

8

示例函数是您正在记录的一个或多个函数或其他代码的使用示例。实施例的功能将被包括在源代码的形式生成的godoc(而其它功能都没有),具有正确的格式,也施加一些处理,例如,如果该示例性函数的最后一行包含的格式输出:

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

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

此外,如果提供输出:运行软件包的测试套件(例如使用go test)也可以执行示例函数,而不需要进一步安排,Go会比较示例函数的输出与最后注释行中指定的输出 - 这样做的结果将决定此示例是否通过“测试”功能。如果在示例函数中未指定输出,则go test将仅编译它,但不会执行它。

看看这个页面:package godoctricks

另外一个博客文章已发表了有关功能。例如:

Testable Examples in Go