delphi - How to put a line break in xmldoc comments -
i have following summary snippet.
/// <summary> /// holds future state 4 pixels /// every pixel can in 4 states, on, off, unknown, or don't care /// off=00, on=01, unknown = 10, don't care = 11. /// grid this: /// <code> /// tl|tr <br/> /// ---+--- <br/> /// bl|br <br/> /// </code> /// </summary> this displayed in popup hint as:
holds future state 4 pixels every pixel can in 4 states,
on, off, unknown, or don't care off=00, on=01, unknown = 10,
don't care = 11. grid this:tl|tr ---+--- bl|br
the ascii art in middle correctly shown in monospaced font, no line breaks.
how line breaks displayed correctly
you can use paragraph break <para/>:
/// <summary> /// grid this: /// <code> /// tl|tr <para/> /// ---+--- <para/> /// bl|br <para/> /// </code> /// </summary> result:

Comments
Post a Comment