This documentation is archived and is not being maintained.

XML Documentation Sample 

Download sample

This sample shows how to use XML to document code. See XML Documentation Comments (C# Programming Guide) for additional information.

Security noteSecurity Note

This sample code is provided to illustrate a concept and should not be used in applications or Web sites, as it may not illustrate the safest coding practices. Microsoft assumes no liability for incidental or consequential damages should the sample code be used for purposes other than as intended.

To open the sample file in Solution Explorer

  1. Click Download Sample.

    The File Download message box appears.

  2. Click Open, and on the left column of the zip folder window, click Extract all files.

    The Extraction Wizard opens.

  3. Click Next. You can change the directory that the files will be extracted to, and then click Next again.

    Make sure that the Show extracted files check box is selected, and click Finish.

  4. Double-click the sample's .sln file.

    The sample solution is displayed in Solution Explorer. You might get a security warning that says the solution location is not trusted. Click OK to continue.

To build the XML Documentation sample within Visual Studio

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

  2. Open the Configuration Properties folder and 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 the Command Line

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

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

    type XMLsample.xml

See Also