Adding comments aka QuickInfo to intellisense

[clemenslinders]

Adding comments aka QuickInfo to intellisense:

On this forum I found in it's history the following thread:
http://www.thescripts.com/forum/thread254408.html

Someone also wanted to add comments to his methods that would show up using intellisense.

In the above mentioned thread Relaxin mentions:
> /// <summary>
> /// Adds string to collection.
> /// </summary>
> /// <remarks>
> /// This is a remark.
> /// </remarks>
> /// <param name="str">The ostring you want to add.</param>
> public void AddString(string str)
> {
> // implementation
> }

Which indeed is the trick, unfortunately he forgets to mention that you need to do ONE special thing before it works. In the C# file in which you add these summary's (the text in this summary will show up as QuickInfo in Intellisense, param name will show up when parameters are entered and remark is just a remark that will not show up).

In VS 2005 goto: Project / NameOfYourProject Properties / Build
here you will find under output: XML document file: with a CheckBox in front. Simply check this checkbox. VS will give your XML outputfile a name and a place (which in most cases will be fine)

That's all.

I found the following website for this subject helpfull:
http://msdn.microsoft.com/msdnmag/issues/02/06/XMLC/

Goodluck

[Plater]

I recently turned that checkbox on, but all it did was build an XML file.
All of my intellisense stuff was already there, no special settings required.


And as a quick time saver tip:
If you place your cursor on the line above a function (or other declaration) and press the / key three times ( "///" ) Visual studio will auto-drop a template for everything in there.

For example this line:

protected void btCASubmit_Click(object sender, EventArgs e)
 

Will auto-drop this as a template:

/// <summary>
/// 
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
protected void btCASubmit_Click(object sender, EventArgs e)