Chức năng ví dụ Go là gì?

Question

The Go gói thử nghiệm đề cập example functions như trong:

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

ý nghĩa là gì và sử dụng trường hợp này?

Answer 1

Ví dụ là các ví dụ về cách sử dụng của gói hoặc chức năng hoặc mã khác mà bạn đang tạo tài liệu. Các hàm mẫu sẽ được bao gồm trong godoc được tạo trong dạng nguồn (trong khi các hàm khác không), với định dạng thích hợp, cũng có một số xử lý được áp dụng, ví dụ nếu dòng cuối cùng của hàm ví dụ có đầu ra theo định dạng:

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

Dòng cuối cùng chỉ định đầu ra sẽ bị tước và hiển thị trong một khối riêng biệt, như có thể thấy ở đây: Example (Output). Ngoài ra nếu đầu ra được cung cấp: chạy bộ kiểm thử của gói (ví dụ: go test) cũng thực thi các hàm mẫu mà không cần sắp xếp thêm từ bạn, và Go so sánh đầu ra của hàm mẫu với đầu ra được chỉ định trong dòng chú thích cuối cùng - kết quả của việc này sẽ xác định xem chức năng ví dụ này có phải là "kiểm tra" hay không. Nếu đầu ra không được chỉ định trong hàm ví dụ, go test sẽ chỉ biên dịch nó nhưng sẽ không thực thi nó.

Check-out trang này: package godoctricks

Cũng là một bài viết trên blog đã được xuất bản về Ví dụ chức năng:

Testable Examples in Go