私のテストにコメントする必要がありますか？

私は新しい機能をカバーする別のJava-Testを書こうとしています。この新しいテストの理由を文書化するために、私はその機能の説明でテストにコメントすることを考えています。私のテストにコメントする必要がありますか？

どうすればよいですか？

テストと機能をリンクするにはどうすればよいですか？

出典

2011-08-15 Steven

おそらく、// Arrange、// Act、// Assert以外の任意のテストが自明であることを望むでしょう –

通常、プロジェクトドキュメントには、ユースケースとテストケースの間のマッピングを含むマトリックスが含まれています – Gaim

http： /stackoverflow.com/q/2198458/307767 – oliholz

テストの対象となる機能とそのテストの条件が明白であるようにテストに名前を付ける必要があります。

何らかの理由でそれができない場合は、テストに最小の解説を追加する必要があります。あなたが書いたANYコードの場合のように。

出典

2011-08-15 06:58:19 GaryF

+1は自明のコードをコメントしていません。 –

通常、私たちが行うのは説明的なテスト名です。テストの失敗の場合、テストコードを調べずに、どの機能が失敗したのかを突き止めることができます。

例：divideWithZeroShouldFailAndThrowAnException()は、Calculatorクラスのdivideメソッドをテストするために計画している場合には、完全なテストメソッド名です。

出典

2011-08-15 07:19:30

まず、テストのコードは自明です。 GaryFの答えに加えて、あまり明確でないケースで何が間違っているのかを説明するメッセージを取るアサートメソッドを使うことを提案します。たとえば、assertEquals(java.lang.String, java.lang.Object, java.lang.Object)

テストコードではなく、テスト結果を見ても何が壊れているのかを理解するのに役立ちます。

出典

2011-08-15 07:21:53 artplastika

私のテストにコメントする必要がありますか？

答えて

関連する問題