解説

ASP.NETで学ぶVisual Studio .NETの魅力

第5回 Visual Studio .NETのヘルプ機能で開発を効率化

山田 祥寛
2003/08/26


■クラスの属性情報を保持する「プロパティ」

 「プロパティ」とは、クラス内部で保持される属性情報のことをいい、OdbcCommandクラスではCommandText(コマンド)やCommandType(コマンドの種類)などが代表的である。

CommandTextプロパティを説明するページ
「プロパティ」はクラス内部で保持される属性情報。

 例えば、上の画面はCommandTextプロパティを説明するページであるが、ページの構成はクラスのそれに酷似しているので、ここでは構文にのみ注目することにしよう。

Public Overridable Property CommandText As String
  Implements IDbCommand.CommandText
       ↓
修飾子 Property プロパティ名 As データ型 Implements 実装インターフェイス

 あえて定義の内容を日本語で説明するならば、「CommandTextプロパティはString型であり、IDbCommandインターフェイスのCommandTextプロパティを実装する。また、どこからでも参照/書き込み可能であり(Public)、派生クラス(子クラス)で上書き(オーバーライド)することも可能である(Overridable)」ということになるだろう。

 構文の記法それ自体ももちろんであるが、まず注目してほしいのは「As」以下の部分である。ここでプロパティのデータ型を知ることができる。データ型にはリンクが張られているはずなので、もしもここで未知のクラスが指定されている場合には、リンクをたどって詳細を参照してみるとよいだろう。特にデータ型が列挙体(定数の集合)である場合には、設定可能な列挙体の値を確認することができる。

■クラスの動作を制御する「メソッド」

 「メソッド」とはクラス内部で保持される属性情報を基に、実際の処理を行う一連の手続き(関数)のことをいう。OdbcCommandクラスであれば、ExecuteNonQueryやExecuteReaderなどのメソッドが代表であろうか。

ExecuteReaderメソッドのページ
メソッドの場合はプロパティと異なり、引数の型や個数などにより複数の書式を持つ場合があるので(メソッドのオーバーロード)、その場合はいきなり詳細のページではなく、まずオーバーロードの一覧が表示される(オーバーロードするメソッドがない場合は直接に詳細のページへリンク)。

 例えば、ExecuteReaderメソッドのページ(上図)では、メソッドの構文は次のように定義されている。

Overloads Public Function ExecuteReader() As OdbcDataReader
Overloads Public Function ExecuteReader(CommandBehavior) As OdbcDataReader
    ↓
  修飾子 Public {Function|Sub} メソッド名(引数,……) [As 戻り値のデータ型]

 あえて定義の内容を日本語で説明するならば、「ExecuteReaderメソッドは省略可能な引数としてCommandBehavior型の値を受け取り、戻り値としてOdbcDataReaderオブジェクトを返す。どこからでも実行可能であり(Public)、引数のみが異なる同名のメソッドが存在する(Overloads)」ということになるだろう。戻り値がない場合には、As以下は省略され、「Function」の個所は「Sub」に置き換わる。

 各構文からは詳細のページにリンクできるが、画面の構成はクラス/プロパティのそれにほとんど等しい。プロパティ同様、戻り値(出力)/引数(入力)のデータ型からさらに詳細をたどることで、おのずとコーディング(入出力)の流れが見えてくるはずである(コーディングとはパラメータを渡し、戻り値を受け取り、またその戻り値をほかのメソッドのパラメータとして渡すことの繰り返しであることを思い出してほしい。そうした意味では、戻り値と引数のリンクをたどっていくことは、コードの流れを直感的にたどるのにも等しい行為なのだ)。

 ……以上、APIリファレンスについて、その構成を説明してきたが、APIリファレンスの内容は当然ながらこれにとどまらない。ASP.NETでの開発を行う場合には、リファレンスの「ASP.NET構文」配下にあるサーバ・コントロールについても軽く目を通しておくとよいだろう。サーバ・コントロールというと、また特殊な概念に思われるかもしれないが、要はクラス・ライブラリをタグの形式で隠ぺいしたものであるにすぎない。サーバ・コントロールのページで個々の概略をつかみ、参照リンクから対応するクラスの説明を確認すると、より理解も早く、また深まるはずである。

 なかなかすべてを読み解くということはできない膨大なドキュメントであるが、時間をかけて参照する価値は十分にあるはずなので、特に初心者を自認する方々は敬遠することなく、初期のうちからリファレンス・マニュアルを参照する癖をつけてほしい。End of Article


 INDEX
  ASP.NETで学ぶVisual Studio .NETの魅力
  第5回 Visual Studio .NETのヘルプ機能で開発を効率化
    1.オペレーションに即応する「ダイナミック・ヘルプ」
    2.従来からある「目次」、「キーワード」ヘルプを使いこなせ
    3.APIリファレンスでクラス・ライブラリの構造を把握する
    4.機能をカプセル化する「クラス」/クラスを生成する「コンストラクタ」
  5.属性情報を保持する「プロパティ」/動作を制御する「メソッド」
 
インデックス・ページヘ  「解説:ASP.NETで学ぶVisual Studio .NETの魅力」


Insider.NET フォーラム 新着記事
  • 第2回 簡潔なコーディングのために (2017/7/26)
     ラムダ式で記述できるメンバの増加、throw式、out変数、タプルなど、C# 7には以前よりもコードを簡潔に記述できるような機能が導入されている
  • 第1回 Visual Studio Codeデバッグの基礎知識 (2017/7/21)
     Node.jsプログラムをデバッグしながら、Visual Studio Codeに統合されているデバッグ機能の基本の「キ」をマスターしよう
  • 第1回 明瞭なコーディングのために (2017/7/19)
     C# 7で追加された新機能の中から、「数値リテラル構文の改善」と「ローカル関数」を紹介する。これらは分かりやすいコードを記述するのに使える
  • Presentation Translator (2017/7/18)
     Presentation TranslatorはPowerPoint用のアドイン。プレゼンテーション時の字幕の付加や、多言語での質疑応答、スライドの翻訳を行える
@ITメールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)

注目のテーマ

Insider.NET 記事ランキング

本日 月間