代码示例
文件名称
代码格式
包方法
类型方法
示例展示
Output断言注释
示例展示
Godoc代码示例
Goland代码提示

代码示例

Golang采用了package包设计的概念，对于包所有导出的包方法以及类型方法都应当有代码示例，代码示例不仅仅是作为包使用的示例，更是单元测试的补充。换句话来讲，你开发的包不仅仅是自己知道怎么使用，更需要通过代码示例告诉团队的其他成员如何使用你开发的包，并且可以通过提高单元测试覆盖率来进一步完善包的代码质量。

代码示例的单元测试覆盖率只能作为单元测试的一个补充，因为代码示例能够实现的单元测试功能比较简单。

文件名称

代码示例的文件放置于包目录中，文件名称一般使用example_test.go，这也是标准库的命名方式。在GF框架的代码中，同一个包下往往存在多个测试文件，代码示例文件的规则一般使用包名_example_test.go文件，并且代码示例文件也可以存在多个，例如：gset_example_any_test.go, gset_example_str_test.go, gset_example_int_test.go用于区分内部不同类型方法的示例。

GF源码文件中有时为了文件排序更优雅，往往会在测试文件命名中加上z的字符便于将所有的测试文件排序到所有包文件末尾，例如：gset_example_z_any_test。

代码格式

包方法

如果是导出的包方法示例，那么示例方法定义为：

func ExampleXXX() {
    // ...
}

其中XXX表示示例的包方法。

类型方法

如果是导出的类型方法示例，那么示例方法定义为：

func ExampleYYY_XXX() {
    // ...
}

其中YYY表示类型名称，XXX表示该类型对应的方法。

示例展示

为了能更好地阐述，我们这里以gset包为例，代码示例文件内容的格式如下：

package gset_test

import (
    "fmt"
    "github.com/gogf/gf/container/gset"
    "github.com/gogf/gf/frame/g"
)

func ExampleSet_IsSubsetOf() {
    var s1, s2 gset.Set
    s1.Add(g.Slice{1, 2, 3}...)
    s2.Add(g.Slice{2, 3}...)
    fmt.Println(s1.IsSubsetOf(&s2))
    fmt.Println(s2.IsSubsetOf(&s1))

    // Output:
    // false
    // true
}