Visual Studio .NETによるチーム開発事始め

Visual C# .NETでAPIリファレンスを作る(前編)

一色 政彦
2003/06/07

4.メンバ情報の参照

 クラス・メンバの詳細情報を参照するには、クラス情報のメンバ一覧から、目的のメンバをクリックする。すると、右ペインにクリックしたメンバの詳細情報が表示される(ここでは例として「resarray」を表示してみる)。

メンバ情報の表示(「プロジェクト」ページ)
特定メンバの情報を参照するには、メンバ一覧で目的のメンバ名をクリックする。
  ここでは例として、[resarray]をクリックしてみる

■フィールド詳細情報の参照

 クラス・メンバからフィールド(クラス内で定義されている変数)を選択した場合は、そのフィールドの概要説明とアクセシビリティ・レベル、フィールドの型、詳細な解説が順に表示される。

 フィールド情報では、例えばフィールドに値を代入するときにデータ型を確認したり、フィールドがフラグとして利用されている場合は、そのフラグの値の意味を解説情報から知ることができるだろう。

フィールド情報(「プロジェクト」ページ)
フィールドの概要、アクセシビリティ・レベル、フィールドの型、解説が表示される。
  フィールドの概要
  アクセシビリティ・レベル
  フィールドの型
  詳細な解説

■メソッド詳細情報の参照

 クラス・メンバのメソッドを選択したときには、メソッドの概要、メソッドの定義(シグネチャ)、引数の型と説明、戻り値の説明、メソッドについての詳細な解説が順に表示される。

 メソッド情報は、メソッドを使うときに、引数に何が設定できるのか、またどんな戻り値が返されるのかを確認する時に役立つだろう。

メソッド情報(「プロジェクト」ページ)
クラス・リストから「Plus」メソッドを選択したところ。
  メソッドの概要
  メソッドの定義
  引数の説明
  戻り値の説明
  解説
「解説」にある「メソッドの使用例」は、ソース・コード中にコメントとして記述した内容が表示されたものである。このようなユーザー定義(独自)の表示は「ドキュメント コメントのタグ」を利用することで実現できる。「ドキュメント コメントのタグ」については、次回で詳しく解説する。

■プロパティ詳細情報の参照

 クラス・メンバのプロパティを選択すると、概要、アクセシビリティ・レベル、プロパティの型、アクセサ・メソッド、解説が順に表示される。

 アクセサ・メソッドとはプロパティにアクセスするためのメソッドで、getアクセサとsetアクセサの2種類がある。getアクセサではプロパティ値の取得ができ、setアクセサはプロパティ値の設定ができる。

 プロパティ情報では、型情報を参照したり、getアクセサとsetアクセサの有無とそのメソッド仕様を確認するのに役立つだろう。

プロパティ情報(「プロジェクト」ページ)
クラス・リストから「result」プロパティを選択したところ。
  プロパティの概要
  アクセシビリティ・レベル
  プロパティの型
  アクセサ(get/set)。これらをクリックすると、アクセサ・メソッドの詳細情報が表示される(表示形式はメソッドと同じ)
  解説

■インデクサ詳細情報の参照

 クラス・メンバのインデクサを選択すると、概要、アクセシビリティ・レベル、インデクサの型、アクセサ・メソッド、詳細な解説が順次表示される。

 インデクサとは、クラスのインスタンスに配列と同じようなインデックスを付ける機能である。例えば、「Calculator」クラスのインスタンス「cal1」があるとすると、「cal1[3]=1」のように、インデックス(この例では「3」)を指定して配列要素にアクセスするコードを記述できる。この配列要素へのアクセスも、プロパティと同じく、getアクセサとsetアクセサの2つのメソッドで実装されている。

 なお、インデクサはインスタンスに付けるものなので、インデクサ名は常に「this」である。ユーザー定義名は使えないので注意していただきたい。

インデクサ情報(「プロジェクト」ページ)
クラス・リストからインデクサ(this[byte index])を選択したところ。
  インデクサの概要
  アクセシビリティ・レベル
  インデクサの型
  アクセサ(get/set)。クリックすると、アクセサ・メソッドの詳細情報が表示される(表示形式はメソッドと同じ)
  詳細な解説

5.次回は

 今回はAPIリファレンスの作成方法と、APIリファレンスの内容について解説した。VS.NETによって生成されるAPIリファレンスは、HTMLデータで、内部にはソリューション・ページとプロパティ・ページという2つの基本ページがあり、これらに表示されるリンクをクリックしていくことで、クラスやクラス・メンバ(フィールド、メソッド、プロパティ、インデクサ)の詳細情報を参照できる。VS.NETの機能を使用すれば、簡単にAPIリファレンスを作成できることがお分かりいただけただろう。

 APIリファレンスに表示される多くの情報はVS.NETにより自動生成される。特に何もしなくても、フィールドのデータ型やアクセシビリティ、メソッドの定義(シグネチャ)などの基本的な情報を参照できるAPIリファレンスが作成可能である。これだけでも、チーム開発にはある程度役に立つのではないだろうか。

 しかし当然ながら、クラスやメソッドに関する解説文までは自動的に作ってくれない。解説文を作るには、ソース・コード中にドキュメント・コメントと呼ばれる、XMLタグを使ったコメントを書く必要があるのだ。次回は、ドキュメント・コメントの書き方や、APIリファレンスの応用について解説する。End of Article


 INDEX
  Visual Studio .NETによるチーム開発事始め
  Visual C# .NETでAPIリファレンスを作る(前編)
    1.APIリファレンスのすすめ
    2.APIリファレンスの作成方法
    3.APIリファレンスを表示する
    4.APIリファレンスの概要
  5.クラス・メンバの詳細情報を参照する
 
インデックス・ページヘ  「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メールマガジン 新着情報やスタッフのコラムがメールで届きます(無料)
- PR -

注目のテーマ

Insider.NET 記事ランキング

本日 月間
ソリューションFLASH