<exception> (C# Programming Guide)

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

Parameters

  • cref = " member"
    A reference to an exception that is available from the current compilation environment. The compiler checks that the given exception exists and translates member to the canonical element name in the output XML. member must appear within double quotation marks (" ").

    For more information on how to create a cref reference to a generic type, see <see> (C# Programming Guide).

  • description
    A description of the exception.

Remarks

The <exception> tag lets you specify which exceptions can be thrown. This tag can be applied to definitions for methods, properties, events, and indexers.

Compile with /doc to process documentation comments to a file.

For more information about exception handling, see Exceptions and Exception Handling (C# Programming Guide).

Example

// 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)
        {
        }
    }
}

See Also

Reference

Recommended Tags for Documentation Comments (C# Programming Guide)

Concepts

C# Programming Guide