问题
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:
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:
VS2017:
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> 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.
回答1:
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.
来源：https://stackoverflow.com/questions/44565660/f-xml-multiline-documentation-visual-studio-2017