QuickInfo method description

  • Thread starter Thread starter Relaxin
  • Start date Start date
R

Relaxin

How do you add a comment description to your functions and properties so
that they will show up when you use the Intellisense QuickInfo or member
list?

I've tried regular C++ comments but that didn't work.
ex.
//Dump test function
void MyFunc(int value)
{
....
}

I've also tried regular C++ comments this way.ex.
void MyFunc(int value) //Dump test function
{
....
}

Please help!!
 
I am sure this should look familiar to you:

/// <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
}

They are called xml documentation, you could search msdn for that to get
familiar with all possible xml elements that you can use.
Ultimately, you can use this kind of code documentation to generate
msdn-like documentation for your code.
Also, you can use tools like NDoc to generate the
latter.(http://ndoc.sourceforge.net/)
 
Back
Top