NDoc User's Guide

NDoc 1.3

<exception>

[This is preliminary documentation and subject to change]

The <exception> tag describes which exceptions can be thrown by a member.

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

where:

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 (" ").
description: A description.

Applies To

Property, Method, Event, Operator, Type Conversion

Remarks

This tag is applied to a method definition.

Example

[C#]
using System;

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

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

See Also

Tag Usage | NDoc Tags | Microsoft's definition