F#XML多行文档，Visual Studio 2017 [英] F# XML multiline documentation, Visual Studio 2017

问题描述

我想添加一个多行XML文档，当我的鼠标悬停在它上面时，该文档将出现在Intelli-Sense气泡中.参见例如:

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:

当我使用Visual Studio 2015时，以下代码有效(请参见下面的屏幕快照)，但是现在当我使用Visual Studio 2017时，它不再起作用:

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:

请参见下面在VS2015和VS2017中拍摄的屏幕截图

See the following screenshot taken in VS2015 and VS2017

VS2015:

VS2017:

在搜索stackoverflow和其他网站之后，我尝试了一些代码，但仍然无法正常工作.

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

如何添加C#.NET文档中的换行符

记录F#代码

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

如何在VS2017中为F#添加多行XML文档?非常感谢您的帮助.

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

推荐答案

有趣的是，在VS 2017中似乎可以使用完全空白的行，而在VS 2015中则行不通:

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.

忽略<para>标记看起来像是VS2017中的错误.

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

这篇关于F#XML多行文档，Visual Studio 2017的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！