How to add a line break in C# .NET documentation

Question

This should be waaaay easier...

I want to add a "coded" line break to the XML documentation in my code

/// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&gt; /// Rather than return SQL, this method returns a string with icon-tokens, which  /// could be used to represent the search in a condensed pictogram format. /// </summary> 

As you can see, I found some answers that demonstrated adding < and > brackets. Interestingly, the good 'ol < br/ > line break does not create a line break in the Intellisense popup.

I find this annoying...

Any suggestions?

Answer 1

You can use a <para /> tag to produce a paragraph break or you can wrap text in <para></para> tags as a way to group the text and add the blank line after it, but there is no equivalent to <br /> or anything like that. (Which according to this old MS forum post is by design.) You can get the list of available tags in this documentation article from MS. Documenting your code

Example (based on original OP sample):

/// <summary> /// <para>Get a human-readable variant of the SQL WHERE statement of the search element.</para> /// Rather than return SQL, this method returns a string with icon-tokens, which  /// could be used to represent the search in a condensed pictogram format. /// </summary>