共用方式為


<exception> (C# 程式設計手冊)

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

參數

  • cref = "member"
    一個可以用於目前編譯環境例外狀況的參考。 編譯器會檢查特定的例外狀況是否存在,並在輸出 XML 中將 member 轉譯為正式的項目名稱。 member 須以用雙引號 (" ") 括住。

    如需如何建立泛型型別之 cref 參考的詳細資訊,請參閱 <see> (C# 程式設計手冊)

  • description
    例外狀況的描述。

備註

這個 <exception> 標記讓您指定可以擲出哪些例外狀況, 這個標記可以套用至方法、屬性、事件和索引子的定義。

使用 /doc 進行編譯,將文件註解處理為檔案。

如需例外狀況處理的詳細資訊,請參閱例外狀況和例外處理 (C# 程式設計手冊)

範例

// 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# 程式設計手冊