C# と VB.NET の質問掲示板

ASP.NET、C++/CLI、Java 何でもどうぞ

C# と VB.NET の入門サイト

Re[5]: VB.NET クラス仕様書について

分類:[.NET 全般]　

VS2008　VB.NET　VISTA

いつもお世話になっております。
タイトルにも記述しましたが、VB.NETのクラス仕様書を作成しているのですが、
今まで、仕様書という物を作成したことがなく、どんな風に書けばいいのか、
どのような項目を設ければいいのかが分かりません。
ネットで調べているのですが、初めてなもので、何が正しくて、正しくないのかが、分かりません。

現状は、以下のような項目があります。

クラス名
ファイル名
内容
NO　名称　スコープ修飾子　データ型　パラメータ名　パラメータ型　処理説明
---------------------------------------------------------------------------
コンストラクタ
---------------------------------------------------------------------------
プロパティ
---------------------------------------------------------------------------
メソッド
---------------------------------------------------------------------------

質問する場所が、違うかもしれませんが、
お願いします。

> タイトルにも記述しましたが、VB.NETのクラス仕様書を作成しているのですが、

その仕様書はクラスを
「使う人」に向けてのものですか?
「作る人」に向けてのものですか?

「使う人」に向けてのものであれば、内部詳細を書く必要はありません。
極論すれば Public なものだけあればいい。

> 現状は、以下のような項目があります。
> ....

このクラスは「何をしてくれるものか」を概説した方がいいですね。
「使う人」向けであればちょっとしたサンプルとかも。

■No38174 (επιστημη さん) に返信
｢作る人｣用に作成しているのですが、

クラス名
ファイル名
内容
NO　名称　スコープ修飾子　データ型　パラメータ名　パラメータ型　処理説明
---------------------------------------------------------------------------
コンストラクタ
---------------------------------------------------------------------------
プロパティ
---------------------------------------------------------------------------
メソッド
---------------------------------------------------------------------------
上記に概説を追加すれば、クラス仕様書と呼べるのでしょうか？

2009/07/08(Wed) 15:22:06 編集(投稿者)

> ...
> 上記に概説を追加すれば、クラス仕様書と呼べるのでしょうか？

呼べます。あとは"全体図"が必要でしょうね。
継承関係やinterfaceなど、他クラスとの関係(繋がり)を明らかにしましょう。
クラスは部品ですから、それら部品がどう組み合わさってるか、を表現します。
# クラス図・オブジェクト図ってやつ。

επιστημη さん
ありがとうございました。

> 処理説明

書き過ぎないように。
「なにをするか」を説明すること。
「どうするか」は作る人が考えることだから。

C# と VB.NET の質問掲示板

ASP.NET、C++/CLI、Java 何でもどうぞ

C# と VB.NET の入門サイト

Re[5]: VB.NET クラス仕様書について

過去ログには書き込み不可