Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

F# XML multiline documentation, Visual Studio 2017

I would like to add a multi-line XML documentation that will appear in the Intelli-Sense bubble when my mouse hover over it. See for example:

enter image description here

When I am using Visual Studio 2015, the following code works (see screenshots below), but now when I use Visual Studio 2017, it does not work anymore:

See the following screenshot taken in VS2015 and VS2017

VS2015:

enter image description here

VS2017:

enter image description here

After searching stackoverflow and other website, I tried some codes, but it is still not working.

// My failed guesses    

/// This also does not work
/// & 
 This does not work
let EXAMPLE3 = 2.0


/// This also does not work
/// \n This does not work
let EXAMPLE4 = 2.0

/// This also does not work
/// <br> This does not work
let EXAMPLE5 = 2.0

/// <summary>
/// This also does not work 
/// <para> &#13; This does not work </para>
/// </summary>
let EXAMPLE6 = 2.0

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

Documenting F# Code

https://www.w3.org/MarkUp/html-spec/html-spec_13.html

How do I add a multi-line XML documentation in VS2017, for F#? Thank you very much for your help.

like image 714
CH Ben Avatar asked Jun 15 '17 10:06

CH Ben


1 Answers

Interestingly, leaving a completely blank line seems to work in VS 2017 but not in VS 2015:

/// First paragraph
///
/// Second paragraph
let example = 1

I don't know if this an intentional new addition.

Ignoring the <para> tag looks like a bug in VS2017.

like image 69
TheQuickBrownFox Avatar answered Oct 20 '22 05:10

TheQuickBrownFox