XML Documentation Sample

This sample shows how to use XML to document code. For more information, see XML Documentation Comments (C# Programming Guide).

To get samples and instructions for installing them

  • Do one or more of the following:

    • On the Help menu, click Samples.

      The Readme displays information about samples.

    • Visit the Visual Studio 2008 Samples Web site. The most recent versions of samples are available there.

    • Locate samples on the computer on which Visual Studio is installed. By default, samples and a Readme file are installed in drive:\Program Files\Microsoft Visual Studio 9.0\Samples\lcid. For Express editions of Visual Studio, all samples are located online.

For more information, see Visual Studio Samples.

Security noteSecurity Note:

This sample code is intended to illustrate a concept, and it shows only the code that is relevant to that concept. It may not meet the security requirements for a specific environment, and it should not be used exactly as shown. We recommend that you add security and error-handling code to make your projects more secure and robust. Microsoft provides this sample code "AS IS" with no warranties.

To build the XML Documentation sample within Visual Studio

  1. In Solution Explorer, right-click the project and then click Properties.

  2. Open the Configuration Properties folder and then click Build.

  3. Set the XML Documentation File property to XMLsample.xml.

  4. On the Build menu, click Build.

    The XML output file will be in the debug directory.

To build the XML Documentation sample from a command prompt

  1. To generate the sample XML documentation, type the following at a command prompt:

    csc XMLsample.cs /doc:XMLsample.xml
  2. To see the generated XML, type the following command:

    type XMLsample.xml

See Also


How to: Use the XML Documentation Features (C# Programming Guide)


Visual C# Samples

C# Programming Guide