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

Home
C# / C Sharp
1.2D Graphics
2.Class Interface
3.Collections Data Structure
4.Components
5.Data Types
6.Database ADO.net
7.Design Patterns
8.Development Class
9.Event
10.File Stream
11.Generics
12.GUI Windows Form
13.Language Basics
14.LINQ
15.Network
16.Office
17.Reflection
18.Regular Expressions
19.Security
20.Services Event
21.Thread
22.Web Services
23.Windows
24.Windows Presentation Foundation
25.XML
26.XML LINQ
C# / C Sharp by API
C# / CSharp Tutorial
C# / CSharp Open Source
C# / C Sharp » Development Class » XML DocumentationScreenshots 
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
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.