如何在 F# 文档中包含命名参数

Question

我想在我的 F# 函数中包含文档。作为一名新用户，我最近发现了 F# 中内置的 XML 标签；这些标签的信息 can be found here.

我的问题是 param 标签在弹出的鼠标悬停 window 中似乎没有任何作用。例如，这个函数，带有简单的 XML 标签：

//A simple function for Whosebug question
/// <summary> A test function to post to Whosebug that doesn't do much at all.</summary>
/// <param name=" x "> A string to pass to the function.</param>
let printString (x: string) = 
    printfn "This is what you input into the function: %s" x

产生此鼠标悬停：

我原以为参数 x 已在此鼠标悬停弹出窗口中定义。标签不正确？如果是这样，要将参数名称包含在智能感知弹出窗口中，标签需要是什么？

感谢您的意见和帮助。

Answer 1

标签是正确的，但出于某种原因，这些弹出窗口只是没有列出参数。对于它的价值，这在 C# 中的工作方式相同。

但是，如果您开始以 C# 样式键入调用，就可以让它像在 C# 中一样工作：

如何在 F# 文档中包含命名参数

How to include named parameters in F# documentation

f#

f#-3.0