Class Comments 1

[robertfah]

Is there a way to format class comments so when they appear in the tooltip of intellisense it looks formatted? For instance, if I have this:

/// <summary>
/// Summary description for Class1.
/// this is just another summary for another class
/// that was created for some reason other than the simple
/// fact of creating a creation of classes to create. 
/// </summary>
class Class1
{
}

When I access Class1 from the code window, intellisense displays a small tooltip window with what's in the <summay> tags. This is what I'm trying to format. Instead of all the text running together and making it hard to read, I'd like to see it something like this:

/// <summary>
/// Summary description for Class1.
/// 
/// This is just another summary for another class
/// that was created.
///
/// Reason:
/// for some reason other than the simple
/// fact of creating a creation of classes to create. 
/// </summary>
class Class1
{
}

I've tried this but it puts it all on one line. I tried <br> and \n\r as well, but nothing seems to work. Any ideas?

 

[jmeckley]

http://msdn.microsoft.com/en-us/library/5ast78ax(VS.80).aspx

i would recommend keeping the comments, if any, to a minimum and use intention revealing interfaces/objects/members.

Jason Meckley
Programmer
Specialty Bakers, Inc.

 

[robertfah]

While the above link is helpful, it still doesn't allow me to enter line breaks between lines within the summary. so my summary line looks like this in the tooltip window:
this is paragraph number 1. this is paragraph number 2.

Instead of

this is paragraph number 1.

this is paragraph number 2.

 

[robertfah]

I'm sorry, I stand corrected, using the <para> tag, you can accomplish this.

Thanks jmeckley!