How to have comments in IntelliSense for function in Visual Studio?

Answer 1

Type in /// on the line before your function and hit return It will generate the stuff required for you to fill in for that stuff to occur. In VB type '''

This will generate an area where you can specify a description for the function and each parameter for the function

Answer 2

Do XML commenting , like this

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

Answer 3

Solmead has the correct answer. For more info you can look at XML Comments.

Answer 4

use /// to begin each line of hte comment and have the comment contain the appropriate xml for the meta data reader.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

Although personally, I believe that these comments are usually misguided, unless you are developing classes where the code cannot be read by its consumers.

Answer 5

Also the visual studio add-in ghost doc will attempt to create and fill-in the header comments from your function name.

Answer 6

What you need is xml comments - basically, they follow this syntax (as vaguely described by Solmead):

C#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

Answer 7

Those are called XML Comments. They have been a part of Visual Studio since forever.

You can make your documentation process easier by using GhostDoc, a free add-in for Visual Studio which generates XML-doc comments for you. Just place your caret on the method/property you want to document, and press Ctrl-Shift-D.

Here's an example from one of my posts.

Hope that helps :)