XML based comments : XML Documentation « Development Class « C# / C Sharp






XML based comments

  
using System;

/// <summary>
/// Main method.
/// <para>This sample is useless.</para>
/// </summary>
class SayHello {
    /// <summary>
    /// This is the Main method for the class and is
    /// the execution starting point for our application.
    /// Please note that <paramref name="args">args</paramref>
    /// is a array of strings.
    /// </summary>
    /// <param name="args">params for Main method</param>
    /// <returns>Returns a value depending on how the program
    /// was called.</returns>
    //We want Main to return an integer.
    public static int Main(string[] args) {
        if (args.Length > 0) {
            return (0);
        }
        return (1);
    }
}

   
  








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.How to write the Xml based document
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