- PR -

JUnitのJavadocコメントについて

1
投稿者投稿内容
とし５１
会議室デビュー日: 2004/06/25
投稿数: 6
投稿日時: 2004-06-25 11:09
こんにちは。
この度、開発でJUnitを使うことになったのですが、テストプログラム=詳細設計書のような位置付けにしたいという要望がありまして、どのようなヘッダ記述にしようか考えております。
どなたかよいサンプルのようなものがあればお教え頂けませんでしょうか。
よろしくお願いします。
/**
* ※ここの部分の記述です。
*
*
*/
public class SampleTest {
}
シュン
ぬし
会議室デビュー日: 2004/01/06
投稿数: 328
お住まい・勤務地: 東京都
投稿日時: 2004-06-25 13:45
(JDK_HOME)/src.zipがJDKのAPIのソースコードですので、これを見るのが
手っ取り早いかとお思います。コードの実装方法もコメントの書き方も、こ
れを読んで盗むのが安上がりです＾＾；

@XXX等のタグの使い方については、JDKのドキュメンテーション→SDKのツー
ル→JAVADOCの項を参照してください。
ＹＯＵ＠ＩＴ
ぬし
会議室デビュー日: 2002/03/29
投稿数: 284
お住まい・勤務地: 大阪
投稿日時: 2004-06-26 10:57
サンプルは無いのですが、例えば
/**
* ○○が△△の場合、□□になることをテストします。
*/
public void testHoge() { ... }

のように書きます。
他に
/**
* 対象 ○○
* 条件 △△
* 結果 □□
*/
のように書いているのも見た事があります。

あまり凝った規約にするとそれに従うのが大変になりますし、
簡素すぎると何をテストしたいのかわかりにくいですし、
その辺のバランスが難しいですね。

あと、コメントも大事ですがメソッド名を適切に命名したり、
テストメソッドの粒度を細かくしたりしてテストコードそのものを
わかりやすくするのも重要だと思います。

つまるところ、ご担当されるプロジェクト内でよく検討して
全員が同意できるものに統一できれば良いのではと。

とし５１
会議室デビュー日: 2004/06/25
投稿数: 6
投稿日時: 2004-06-28 14:53
ご返答どうもありがとうございます。

確かに、凝り過ぎると深みにはまってしまいそうなので
その部分の調整が難しいと思っていたところです。

パッと見て分かりやすいのが一番なのでしょうが、
テストした内容をそんなに分かりやすく書くのは難しいでしょうし。。
ちいにぃ
大ベテラン
会議室デビュー日: 2002/05/28
投稿数: 244
投稿日時: 2004-06-28 15:06
JUnitのテストコードの @ タグを独自に定義して、
Docletで処理するものがあるかもしれないと思い、
Google で検索してみました。キーワードは「JUnit Dcolet」。

すると、最初のほうで TDoclet ってのが見つかりました。
ちょっと便利そうです。

http://t-doclet.sourceforge.jp/
http://sourceforge.jp/projects/t-doclet/

こういうアプローチもありかと思います。
1

スキルアップ／キャリアアップ（JOB@IT）