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

by

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>

More Related Contents:

  1. How do you get XML comments to appear in a different project (dll)?
  2. Can you call Directory.GetFiles() with multiple filters?
  3. Easiest way to read from and write to files
  4. How to check for file lock? [duplicate]
  5. What is the ‘dynamic’ type in C# 4.0 used for?
  6. execute c# code at runtime from code file
  7. C# List Sort by x then y
  8. Converting Bitmap PixelFormats in C#
  9. How do I fix a .NET windows application crashing at startup with Exception code: 0xE0434352?
  10. Why Func instead of Predicate?
  11. Wrapping StopWatch timing with a delegate or lambda?
  12. A dictionary object that uses ranges of values for keys
  13. WCF Service Client: The content type text/html; charset=utf-8 of the response message does not match the content type of the binding
  14. A reproducible example of volatile usage
  15. The State of Linkers for .NET apps (aka “Please Sir, May I have a Linker” 2009 edition)
  16. How to Combine two lambdas [duplicate]
  17. thread with multiple parameters
  18. How to inject an attribute using a PostSharp attribute?
  19. WebClient runs javascript
  20. Why can I use a collection initializer with private set access from another class?
  21. Lock (Monitor) internal implementation in .NET
  22. Data binding for TextBox
  23. How to specify data attributes in razor, e.g., data-externalid=”23151″ on @this.Html.CheckBoxFor(…)
  24. Method to determine if path string is local or remote machine
  25. How do I mock User.Identity.GetUserId()?
  26. Azure Blob Storage | AcquireLeaseAsync, synchronously wait until lock is released
  27. How to exit all running threads?
  28. .indexOf for multiple results
  29. Is TLS 1.1 and TLS 1.2 enabled by default for .NET 4.5 and .NET 4.5.1?
  30. How do I atomically swap 2 ints in C#?

Leave a Comment