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!

Leave a Reply