Home How to put a line break in xmldoc comments
Reply: 1

How to put a line break in xmldoc comments

Johan
1#
Johan Published in 2017-09-11 09:39:13Z

I have a following summary snippet.

  /// <summary>
  ///  Holds the future state for 4 pixels
  ///  Every pixel can be in 4 states, on, off, unknown, or don't care
  ///  Off=00, on=01, unknown = 10, don't care = 11.
  ///   The grid is like this:
  ///   <code>
  ///      TL|TR        <br/>
  ///     ---+---       <br/>
  ///      BL|BR        <br/>
  ///  </code>
  /// </summary>

This is displayed in the popup hint as:

Holds the future state for 4 pixels Every pixel can be in 4 states,
on, off, unknown, or don't care Off=00, on=01, unknown = 10,
don't care = 11. The grid is like this: TL|TR ---+--- BL|BR

The ascii art in the middle is correctly shown in monospaced font, but no line breaks.
How to I get the line breaks to be displayed correctly

Victoria
2#
Victoria Reply to 2017-09-11 09:52:41Z

You can use paragraph break <para/>:

/// <summary>
/// The grid is like this:
/// <code>
///      TL|TR        <para/>
///     ---+---       <para/>
///      BL|BR        <para/>
/// </code>
/// </summary>

Result:

You need to login account before you can post.

About| Privacy statement| Terms of Service| Advertising| Contact us| Help| Sitemap|
Processed in 0.307944 second(s) , Gzip On .

© 2016 Powered by cudou.com design MATCHINFO