This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!
<exception>
<exception cref="member">description</exception>
where:
- cref="member"
- A reference to a member or field that is available to be called from the current compilation environment. The compiler checks that the given code element exists and translates member to the canonical element name in the output XML. member must appear within double quotation marks (" ").
- description
- A description for the exception class.
Remarks
The <exception> tag lets you document an exception class.
Compile with /doc to process documentation comments to a file.
Example
using System;
/// <exception cref="System.Exception">This is an exception class.</exception>
class EClass : Exception {
}
class TestClass {
public static void Main() {
try {
}
catch(EClass) {
}
}
}
See Also
Tags for Documentation Comments