In Visual Studio and C#, when using a built in function such as ToString(), IntelliSense shows a yellow box explaining what it does.
How can I have that for functions and properties I write?
In Visual Studio and C#, when using a built in function such as ToString(), IntelliSense shows a yellow box explaining what it does.
How can I have that for functions and properties I write?
To generate an area where you can specify a description for the function and each parameter for the function, type the following on the line before your function and hit Enter:
C#: ///
VB: '''
See Recommended Tags for Documentation Comments (C# Programming Guide) for more info on the structured content you can include in these comments.
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
Do XML commenting , like this
/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}
use /// to begin each line of the 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.
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 :)
Also the visual studio add-in ghost doc will attempt to create and fill-in the header comments from your function name.