(相關(guān)資料圖)
示例函數(shù)
除了測(cè)試和基準(zhǔn)測(cè)試之外,testing包還提供了一些示例函數(shù),可以用于生成代碼示例和文檔。
Example函數(shù)
Example函數(shù)可以用于生成代碼示例,以便開發(fā)者更好地了解如何使用被測(cè)試的代碼。
func ExampleAdd() { fmt.Println(Add(1, 2)) // Output: 3}
在這個(gè)例子中,我們定義了一個(gè)名為ExampleAdd的示例函數(shù),用于演示Add函數(shù)的使用方法。在示例函數(shù)中,我們調(diào)用Add函數(shù),并使用fmt.Println函數(shù)輸出函數(shù)的返回值。在函數(shù)的最后,我們使用注釋// Output: 3來(lái)指定預(yù)期的輸出結(jié)果。
在運(yùn)行示例函數(shù)時(shí),testing包會(huì)自動(dòng)運(yùn)行函數(shù),并將輸出與預(yù)期的輸出結(jié)果進(jìn)行比較。如果輸出與預(yù)期結(jié)果一致,則示例函數(shù)運(yùn)行成功,否則測(cè)試失敗。
Example函數(shù)和Output注釋
在示例函數(shù)中,我們可以使用Output注釋來(lái)指定預(yù)期的輸出結(jié)果,這有助于我們編寫更好的示例代碼。
func ExampleAdd() { fmt.Println(Add(1, 2)) // Output: 3}func ExampleSub() { fmt.Println(Sub(1, 2)) // Output: -1}
在這個(gè)例子中,我們定義了兩個(gè)示例函數(shù)ExampleAdd和ExampleSub,用于演示Add和Sub函數(shù)的使用方法。在示例函數(shù)中,我們調(diào)用相應(yīng)的函數(shù),并使用fmt.Println函數(shù)輸出函數(shù)的返回值。在函數(shù)的最后,我們使用注釋// Output:來(lái)指定預(yù)期的輸出結(jié)果。
在運(yùn)行示例函數(shù)時(shí),testing包會(huì)自動(dòng)運(yùn)行函數(shù),并將輸出與預(yù)期的輸出結(jié)果進(jìn)行比較。如果輸出與預(yù)期結(jié)果一致,則示例函數(shù)運(yùn)行成功,否則測(cè)試失敗。
關(guān)鍵詞: