怎样为Golang配置自动化文档测试 使用example测试生成文档片段

go test

go test

Example

// Output:

go test

package mypackage

import "fmt"

// ExampleHello demonstrates a simple usage of the Hello function.
func ExampleHello() {
    fmt.Println(Hello("World"))
    // Output:
    // Hello, World!
}

func Hello(name string) string {
    return fmt.Sprintf("Hello, %s!", name)
}

Hello

go test

// Output:

// Unordered output:

go doc

godoc

go test

go doc

godoc

.PHONY: test doc

test:
    go test ./...

doc:
    godoc -http=:6060 # 运行godoc服务器，方便本地查看
    # 或者使用 go doc 生成纯文本文档
    # go doc -all > doc.txt

make test

make doc

godoc

http://localhost:6060

godoc

go install golang.org/x/tools/cmd/godoc@latest

log.Fatal

panic

fmt.Println

// Output:

package mypackage

import "fmt"

// ExampleDivide demonstrates error handling in the Divide function.
func ExampleDivide() {
    result, err := Divide(10, 0)
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(result)
    // Output:
    // division by zero
}

func Divide(a, b int) (int, error) {
    if b == 0 {
        return 0, fmt.Errorf("division by zero")
    }
    return a / b, nil
}

Divide

// Output:

t.Fatal

t.Error

func ExampleDivide(t *testing.T)