XML Documentation: Compiler Support Tags : XML Documentation « Development Class « C# / C Sharp

XML Documentation: Compiler Support Tags

using System;

namespace Payroll
    /// <summary> 
    /// Comments for the class
    /// This class class contains a <see cref="String">string</see>
    /// </summary>
    public class Employee
        /// <summary>
        /// Constructor for an Employee instance. Note that
        /// <paramref name="name">name2</paramref> is a string.
        /// </summary>
        /// <param name="id">Employee id number</param>
        /// <param name="name">Employee Name</param>
        public Employee(int id, string name)
            this.id = id;
            this.name = name;
        /// <summary>
        /// Parameterless constructor for an employee instance
        /// </summary>
        /// <remarks>
        /// <seealso cref="Employee(int, string)">Employee(int, string)</seealso>
        /// </remarks>
        public Employee()
            id = -1;
            name = null;
        int id;
        string name;


Related examples in the same category

1.set up project with one file containing the tag
2.Use summary element
3.How to write the Xml based document
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