F#XML多行文档,Visual Studio 2017

时间:2023-01-14 19:07:02

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:

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

F#XML多行文档,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:

当我使用Visual Studio 2015时,以下代码可以工作(请参阅下面的屏幕截图),但现在当我使用Visual Studio 2017时,它不再起作用了:

See the following screenshot taken in VS2015 and VS2017

请参阅VS2015和VS2017中的以下屏幕截图

VS2015:

VS2015:

F#XML多行文档,Visual Studio 2017

VS2017:

VS2017:

F#XML多行文档,Visual Studio 2017

After searching * 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

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

Documenting F# Code

记录F#代码

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

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.

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

1 个解决方案

#1


1  

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

有趣的是,留下一个完全空白的线似乎在VS 2017中有效但在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.

忽略 标签看起来像VS2017中的错误。

#1


1  

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

有趣的是,留下一个完全空白的线似乎在VS 2017中有效但在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.

忽略 标签看起来像VS2017中的错误。