【问题标题】:F# XML multiline documentation, Visual Studio 2017F# XML 多行文档,Visual Studio 2017
【发布时间】:2017-11-17 20:07:54
【问题描述】:

我想添加一个多行 XML 文档,当我将鼠标悬停在 Intelli-Sense 气泡上时该文档将出现。例如:

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

请看以下在 VS2015 和 VS2017 中截取的截图

VS2015:

VS2017:

搜索了stackoverflow和其他网站后,我尝试了一些代码,但还是不行。

// 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

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

【问题讨论】:

  • 你能把这个放在Visual F# Issues上吗?在 F# 工具中的智能感知文档弹出窗口上做了很多工作,所以它可能来自那里。
  • @s952163 刚刚将该问题添加到 Visual F# 问题。感谢您的建议。

标签: xml visual-studio f#


【解决方案1】:

有趣的是,留下一个完全空白的行似乎在 VS 2017 中有效,但在 VS 2015 中无效:

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

我不知道这是不是有意添加的。

忽略&lt;para&gt; 标记看起来像是 VS2017 中的一个错误。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2010-10-25
    相关资源
    最近更新 更多