我想在我的F#
函数中添加文档。作为一个新用户,我最近发现了F#
中内置的XML标记;这些标记的信息can be found here。
我的问题是param
标签似乎在弹出的鼠标悬停窗口中没有做任何事情。例如,这个函数带有简单的XML标记:
//A simple function for StackOverflow question
/// <summary> A test function to post to StackOverflow 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
。标签不正确吗?如果是这样,标签需要什么才能将参数名称包含在intellisense弹出窗口中?
感谢您的意见和帮助。