7

Go標準ライブラリにはいくつかの優れた実行可能ファイルの例があります。このような例を自分のAPIドキュメントに追加するにはどうすればよいですか？

4

1 に答える 1

11

の出力$ go help testfunc：

'go test'コマンドは、テスト対象のパッケージに対応する "* _test.go"ファイルで、テスト、ベンチマーク、およびサンプル関数を検索することを想定しています。

テスト関数は、TestXXX（XXXは小文字で始まらない英数字の文字列）という名前の関数であり、署名が必要です。

 func TestXXX(t *testing.T) { ... }

ベンチマーク関数はBenchmarkXXXという名前の関数であり、署名が必要です。

 func BenchmarkXXX(b *testing.B) { ... }

関数の例はテスト関数に似ていますが、* tests.Tを使用して成功または失敗を報告する代わりに、出力をos.Stdoutおよびos.Stderrに出力します。その出力は、関数の「Output：」コメントと比較されます。これは、関数本体の最後のコメントである必要があります（以下の例を参照）。そのようなコメントがない、または「Output：」がコンパイルされたが実行されなかった後にテキストがない例。

Godocは、ExampleXXXの本体を表示して、関数、定数、または変数XXXの使用法を示します。レシーバータイプTまたは*TのメソッドMの例は、ExampleT_Mという名前です。末尾の_xxxで区別される、特定の関数、定数、または変数の例が複数ある場合があります。ここで、xxxは大文字で始まらない接尾辞です。

例の例を次に示します。

func ExamplePrintln() {
        Println("The output of\nthis example.")
        // Output: The output of
        // this example.
}

テストファイル全体は、単一のサンプル関数、少なくとも1つの他の関数、型、変数、または定数宣言が含まれ、テスト関数またはベンチマーク関数が含まれていない場合の例として示されています。

詳細については、テストパッケージのドキュメントを参照してください。

于 2012-12-10T06:54:07.987 に答える