Commented remarks in separate lines using Sandcastle help file builder

Mar 11, 2010 at 10:21 PM

Sandcastle will generate the document with summery comments in a paragraph style. Is there any way where we can get the commented summery and  remarks in separate lines as like it is in the code.

I tried to show the commented portion of my code in separate lines by using “\n” and line break <br>

But the sandcastle is displaying these tags as it like that in the comments.

Can anyone tell me the different ways which we need to follow?


Thank you in advance.

Mar 11, 2010 at 10:29 PM

Adding the html tag line break </br> at the end of each line will works. But the problem with this is we need to add these tags at the end of each comment line.


Is there any other way ?

Mar 12, 2010 at 12:48 AM

Hello,

Are you using the <para> tag for your summary and remarks?

Best regards,
Paul. 

Mar 12, 2010 at 3:33 PM
Edited Mar 12, 2010 at 3:35 PM

Hi Paul,

I didn't used any paragraph tags out side of summary comments.

My code comments are like this.

//<summary>   

 // This class performs the validations of Allocation Buckets relative to other related entities.''' 

// New Asset Name is required. 

//</summary>  

 

And the Sandcastle document is combining these two lines in to a paragraph.

like : This class performs the validations of Allocation Buckets relative to other related entities. New Asset Name is required.

 

Mar 12, 2010 at 4:38 PM

Hi,,

So what's wrong with Paul's suggestion?

///<summary>
/// <para>
/// This class performs the validations of Allocation Buckets relative to other related entities.
/// </para><para>
/// New Asset Name is required. 
/// </para>
///</summary>

http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

- Dave

Mar 12, 2010 at 6:33 PM
Edited Mar 12, 2010 at 6:34 PM

Hi Dave and Paul,

Yes the best is just to let the text flow as it does and insert paragraph tags where we need them to start new paragraphs.

Regards,

Sasi