Example for Documentation Tags

Posted by AbundantCode 
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Diagnostics;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WindowsFormsApplication1
{
#region testregion
/// <summary>
/// This is a test Class Form1
/// </summary>
public partial class Form1 : Form
{
/// <summary>
/// Constructor for the Form1
/// </summary>
public Form1()
{
InitializeComponent();
}
/// <summary>
/// Form Load Event of the Form1
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
/// <remarks>
/// <seealso cref="Form2_Load"/>
/// </remarks>
/// <exception cref=""/>
/// <example>
///  private void Form1_Load(object sender, EventArgs e)
///{
///    Debug.WriteLine("This is a test message");
///}
/// </example>
private void Form1_Load(object sender, EventArgs e)
{
Debug.WriteLine("This is a test message");
}
}
#endregion
}
Tags: