Every class and member should have a one sentence summary describing its purpose. More...

Detailed Description

Every class and member should have a one sentence summary describing its purpose.

REMARKS: You can expand on that one sentence summary to provide more information for readers. In this case, the ExampleClass provides different C# elements to show how you would add documentation comments for most elements in a typical class.

The remarks can add multiple paragraphs, so you can write detailed information for developers that use your work. You should add everything needed for readers to be successful. This class contains examples for the following:

Summary	This should provide a one sentence summary of the class or member.
Remarks	This is typically a more detailed description of the class or member
para	The para tag separates a section into multiple paragraphs
list	Provides a list of terms or elements
returns, param	Used to describe parameters and return values
value	Used to describe properties
exception	Used to describe exceptions that may be thrown
c, cref, see, seealso	These provide code style and links to other documentation elements
example, code	These are used for code examples

The list above uses the "table" style. You could also use the "bullet" or "number" style. Neither would typically use the "term" element.
Note: paragraphs are double spaced. Use the br tag for single spaced lines.

The documentation for this class was generated from the following file:

U:/00000000_global_projects/000_DotNetxx/fho.frm.net.Microsoft_DotNetSamples/fho.frm.net.Microsoft_DotNetSamples/ClassMethode/SampleXMLDescription.cs