Parameter Comments

[Danimoth]

Hello all.
I am using VS2008 (so its .NET 3.5).
When using a class, eg DateTime() and i have typed the following:

DateTime dt = new DateTime(

a pop-up is displayed containing the various constructors. It also contains a comment explaining what the various parameters of the constructor does.
For example, in the attached image you can see the comment saying:

ticks: A date and time expressed in 100-nanosecond units.

How do i add such comments to classes/function i create myself??

[monalin]

Its pretty simple...

        /// <summary>
        /// Create's a new LoginCookie for a user
        /// </summary>
        /// <param name="userId">UserId of the user who's logging in</param>
        /// <param name="username">Username of the user who's logging in</param>
        /// <param name="domain">Domain of the site who is issuing the cookie</param>
        public LoginCookie(Int32 userId, String username, String domain)
        {

        }

This article might shine some more light on the subject.
http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

[BigEd781]

Just to add one bit of info; just type three '/' characters in a row above a member or method and the skeleton will be generated automatically for you.

[Danimoth]

Thank you guys!
So this is called "XML Documentation Comments".

Thanks again!

[Arjay]

The intellisense comments are just the tip of the iceberg.

Not only do the xml comments allow for these, they also allow you to build complete documentation for your assemblies.

Check out SandCastle and the SandCastle Help File Builder tools.

[monalin]

Never knew the xml comments were so powerful. I always assumed there was a tool to convert them to documentation but never looked for it.

Now if only I can get my lazy superiors to use xml comments religiously like I do then I might have some decent documentation for the new developers at work.