<exception> (C# プログラミング ガイド)

<exception cref="member">description</exception>

パラメータ

• cref = "member"
  現在のコンパイル環境から利用可能な例外への参照。コンパイラは、指定された例外が存在することを確認してから、member を出力先 XML 内で標準要素名に変換します。member は二重引用符 (" ") で囲みます。

  ジェネリック型への cref 参照の作成方法の詳細については、「<see> (C# プログラミング ガイド)」を参照してください。

• description
  例外の説明。

解説

<exception> タグを使用すると、スローできる例外を指定できます。このタグは、メソッド、プロパティ、イベント、およびインデクサの定義に適用できます。

コンパイル時に /doc を指定してドキュメント コメントをファイルに出力します。

使用例

// compile with: /doc:DocFileName.xml 

/// comment for class
public class EClass : System.Exception
{
    // class definition...
}

/// comment for class
class TestClass
{
    /// <exception cref="System.Exception">Thrown when...</exception>
    public void DoSomething()
    {
        try
        {
        }
        catch (EClass)
        {
        }
    }
}

参照

関連項目

ドキュメント コメント用の推奨タグ (C# プログラミング ガイド)

概念

C# プログラミング ガイド