XML コード コメントの追加
更新 : 2007 年 11 月
コード コメントとは、ソース コード ファイル内に記述されたコメントであり、統合開発環境 (IDE: Integrated Development Environment) のユーザーは IntelliSense 機能を介して使用できます。
[Visual Basic]
Visual Basic では、行頭に 3 つの単一引用符 (''') を入力することによって XML コード コメントを作成できます。詳細については、「方法 : Visual Basic で XML ドキュメントを作成する」を参照してください。
[C#、J#]
XML ドキュメント機能を使用すると、コード コメントを記述できます。ソリューションのソース ファイルに定義された型やメンバに対し、XML ドキュメント コメントによる注釈を付けると、これらのコメントを、次のような IntelliSense 機能で表示できます。
.gif "メモ") メモ : |
|---|
部分メソッドにコメントを記述する場合、定義ではなく実装に記述されたコメントのみが IntelliSense 機能で表示されます。 |
詳細については、「XML ドキュメント コメント (C# プログラミング ガイド)」を参照してください。
[C++]
既定では、// または /* をデリミタとして使用したソース コード内のコメントは、[メンバ] ボックスの該当メンバの横に表示されます。詳細については、「C++ Comments」および「XML Documentation (C++)」を参照してください。
リスト内をスクロールすると、IntelliSense では強調表示されているメンバの横にポップアップ ウィンドウを開き、コメントが 12 行まで表示されます。1 つの関数に複数のコメントがある場合は、コード内の位置に応じて、IntelliSense はどのコメントを [メンバ] に表示するかを決定します。
IntelliSense によって、最初に、宣言の行末 (EOL: end-of-line) コメントが表示されます。次に例を示します。
void MyFunction(); //EOL declaration commentsIntelliSense でこのコメントが見つからなかった場合は、宣言の直前にあるコメントが表示されます。間に空白行は表示されません。次に例を示します。
//Before declaration comments void MyFunction();上の 2 種類のコメントが見つからなかった場合は、IntelliSense によって定義の行末 (EOL) コメントが表示されます。次に例を示します。
int CMyAppDoc::MyVariable=2; // EOL definition comments上の 3 種類のコメントが見つからなかった場合は、IntelliSense によって、定義の直前にあるコメントが表示されます。間に空白行は表示されません。次に例を示します。
//Before definition comments CMyAppDoc::MyFunction() { return; }