How to write the Xml based document : XML Documentation « Development Class « C# / C Sharp






How to write the Xml based document

  
using System;
using System.Collections.Generic;
using System.Text;

namespace XmlDocCar
{
    /// <summary>
    ///  This is a simple Car.
    /// </summary>
    public class Car
    {
        /// <summary>
        /// Do you have a sunroof?
        /// </summary>
        private bool hasSunroof = false;

        /// <summary>
        /// The ctor lets you set the sunroofedness.
        /// </summary>
        /// <param name="hasSunroof"></param>
        public Car(bool hasSunroof)
        {
            this.hasSunroof = hasSunroof;
        }

        /// <summary>
        /// This method allows you to open your sunroof.
        /// </summary>
        /// <param name="state"> </param>
        public void OpenSunroof(bool state)
        {
            if (state == true && hasSunroof == true)
                Console.WriteLine("has sub roof!");
            else
                Console.WriteLine("you don't have a sunroof.");
        }
    }
}

   
  








Related examples in the same category

1.set up project with one file containing the tag
2.Use summary element
3.XML Documentation: Compiler Support Tags
4.XML based comments
5.Summary doc tag, example doc tag
6.value doc tag
7.Summary doc tag and paramref tag
8.Use code tag to reference code
9.permission cref doc tag