<exception> ドキュメント タグ
<exception> タグを使用すると、スローできる例外を指定できます。 このタグは、メソッドの定義に適用されます。
構文
/// <exception cref="member">description</exception>
パラメーター
member
現在のコンパイル環境から使用できる例外の参照。 名前参照ルールを使用し、コンパイラは、指定された例外が存在し、出力の XML で member が正規要素名に変換されることを確認します。 コンパイラでは、member が見つからない場合に警告を発行します。
名前は、一重引用符または二重引用符で囲みます。
ジェネリック型への cref 参照を作成する方法について、詳しくは「<see>」を参照してください。
description
説明です。
Remarks
コンパイル時に /doc を指定して、ドキュメント コメントをファイルに出力します。
MSVC コンパイラでは、ドキュメント コメントを通じて 1 回渡すことで cref 参照を解決しようとします。 C++ のルックアップ規則を使用する場合、コンパイラによってシンボルが見つからないと、参照が未解決としてマークされます。 詳細については、「<seealso>」を参照してください。
例
// xml_exception_tag.cpp
// compile with: /clr /doc /LD
// post-build command: xdcmake xml_exception_tag.dll
using namespace System;
/// Text for class EClass.
public ref class EClass : public Exception {
// class definition ...
};
/// <exception cref="System.Exception">Thrown when... .</exception>
public ref class TestClass {
void Test() {
try {
}
catch(EClass^) {
}
}
};