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

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

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

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


(過去ログ 65 を表示中)

[トピック内 6 記事 (1 - 6 表示)]  << 0 >>

■38170 / inTopicNo.1)  VB.NET クラス仕様書について
  
□投稿者/ 笹かま (3回)-(2009/07/08(Wed) 14:37:56)

分類:[.NET 全般] 

VS2008 VB.NET VISTA

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

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

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

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








引用返信 編集キー/
■38174 / inTopicNo.2)  Re[1]: VB.NET クラス仕様書について
□投稿者/ επιστημη (2029回)-(2009/07/08(Wed) 14:55:22)
επιστημη さんの Web サイト
> タイトルにも記述しましたが、VB.NETのクラス仕様書を作成しているのですが、

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

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

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

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

引用返信 編集キー/
■38179 / inTopicNo.3)  Re[2]: VB.NET クラス仕様書について
□投稿者/ 笹かま (4回)-(2009/07/08(Wed) 15:13:34)
No38174 (επιστημη さん) に返信
「作る人」用に作成しているのですが、

クラス名
ファイル名
内容
NO 名称 スコープ 修飾子 データ型 パラメータ名 パラメータ型 処理説明
---------------------------------------------------------------------------
コンストラクタ
---------------------------------------------------------------------------
プロパティ
---------------------------------------------------------------------------
メソッド
---------------------------------------------------------------------------
上記に概説を追加すれば、クラス仕様書と呼べるのでしょうか?
引用返信 編集キー/
■38181 / inTopicNo.4)  Re[3]: VB.NET クラス仕様書について
□投稿者/ επιστημη (2032回)-(2009/07/08(Wed) 15:19:34)
επιστημη さんの Web サイト
2009/07/08(Wed) 15:22:06 編集(投稿者)

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

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

引用返信 編集キー/
■38188 / inTopicNo.5)  Re[4]: VB.NET クラス仕様書について
□投稿者/ 笹かま (5回)-(2009/07/08(Wed) 15:46:42)
επιστημη さん
ありがとうございました。
解決済み
引用返信 編集キー/
■38193 / inTopicNo.6)  Re[5]: VB.NET クラス仕様書について
□投稿者/ επιστημη (2037回)-(2009/07/08(Wed) 16:01:36)
επιστημη さんの Web サイト
> 処理説明

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

解決済み
引用返信 編集キー/


トピック内ページ移動 / << 0 >>

このトピックに書きこむ

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

管理者用

- Child Tree -