Documentation comments in C#

If partial classes are commented by XML doc strings, then the C# compiler will append the text of documentation into one paragraph. So make sure you use <para/> before or after  your comment string. For example,

/// <summary>
/// <para/>
/// Yadda Yadda Yadda
/// </summary>
partial class PageMarginsDialog : Window
{
    //... Your code here
}

… I did’nt know this before. Cool!

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: