Creating Web Based Comments
By Faiza Ajaz

There are times when you need to explain the core structure and logic of your program, having an intention to make it encapsulated and hidden at the same time. It always pays to keep away your actual coding from the reach of your client, and in some cases, from your fellow-programmers. So in such cases, you need to give a bird-eye view of your program, which encompasses the number of classes and a brief description of methods and variables used in them. This information is more than enough for anyone to familiarize himself with your program.

Fortunately, Microsoft .Net programmers were vigilant and kind enough to provide us with a feature that is amazingly easy and fun. You can view the structure of your code using code comment Web reports. These reports display information about the structure of your code in a series of .htm pages. If you are coding in C#, you can also add custom comments to your code that can then display in the report. The feature is provided in none other than Visual Studios .Net IDE. Here in this article, I am presenting the way it is done. Consider a very simple sample project to make the web based project report.

namespace UsingWebComments
{
    using System;

    /// 

    ///    Summary description for Class1.
    /// 
    public class Class1
    {
        public Class1()
        {
            //
            // TODO: Add Constructor Logic here
            //
		}

        public static int Main()
        {
            //
            // TODO: Add code to start application here
            //
            Class2 PrintName = new Class2();
			PrintName.Display();
			return 0;
        }
    }

			class Class2
	{
		private static string Name = "Faiza Ajaz";

		public void Display()
		{
			Console.WriteLine(Name);
		}
	}
}