2011-09-16 10 views
2

私は渡されたレガシーシステムに対して数十回のテストを行いました。テストからドキュメンテーションを構築するためのドキュメントツール

一般的には、システムの高水準な機能をテスト/記述していますが、テストファイル自体には、その機能に関するコメントが含まれています。このように、私は回帰テストスイートを持っており、システムの知識を一箇所に集約しているので、将来の他の人が(今までの)理解しようとしていたすべての時間を失う必要はありません。文書化されていないシステム。

今、私は、テストファイルを参照するよりも簡単な方法で上位レベルの機能を整理して表示できるツールを探していました。それがタグシステムを許可すれば、さらに良い。

私はFitnesseについて聞いたことがありますが、実際に私が探しているものに合うようには見えません。私は、クライアントと開発者の間のコミュニケーションを橋渡しするツールを探しているわけではありません。

このプロジェクトはJavaでコーディングされています。

おかげ

答えて

2

あなたがテストしているクラスにユニットテストからドキュメントを移動した場合、あなたは標準のJavaDocやDoxygenのいずれかを使用することができます。

+0

私は既に自分のシステムのクラスを文書化するためにJavaDocを使用しています。しかし、それはメソッドシグネチャのみを文書化するだけであり、あまり多くはありません。私のテストは、システム全体のテストであり、システム全体をテストしています。テストのドキュメントをテスト対象のクラスに渡すことはできません。 –

+2

JavaDocは、アプリケーションにとって意味がある場合は、テストクラスで実行できます。 JavaDocはメソッドシグニチャを出力するだけではありません。いくつかの例を見るには、[Doclet Introduction](http://download.oracle.com/javase/1.4.2/docs/tooldocs/javadoc/overview.html)を参照してください。基本的に、独自のテンプレートを、標準タグまたは独自のカスタムタグを使用して表示する方法でレンダリングすることができます。 JavaDocアプリケーションがメソッドシグネチャを生成するために使用するすべてのASTデータにアクセスできます。 JavaDocは、必要な場合には実際に多用途です。 – dlawrence

+0

私はそれをチェックします。私はJavaDocの多様性を認識していませんでした。 –

関連する問題