官博譯文：可測試的 Golang 程式碼範例

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

簡介

Dodoc 的 樣本 是一些可執行檔測試代碼的彙總，他們做為包的文檔中的一部分提供給讀者閱讀和執行。讀者可以點擊 "Run" 按鈕來測試代碼。

Golang 的標準包包括很多這種程式碼範例（比如 strings 包）

本文將樣本如何寫出類似的程式碼範例。

樣本即單元測試

程式碼範例作為包的一部分編譯並執行。

在典型的單元測試中，樣本就是包內 _test.go 檔案中的一些方法。程式碼範例跟測試代碼不同，樣本方法以 Example 開頭（不同於測試代碼的 Test）並且沒有參數。

stringutil 包是 golang 程式碼範例倉庫中的一部分。下面的代碼展示了他是如何示範 Reverse 的用法。

package stringutil_testimport ("fmt""github.com/golang/example/stringutil")func ExampleReverse() {fmt.Println(stringutil.Reverse("hello"))// Output: olleh}

上述代碼可以在 stringutil 目錄下的 example_test.go 檔案中找到。

Godoc 在 Reverse 方法的文檔中展示了這個程式碼範例，詳見圖：