关于XML文档的MSDN页面显示您可以编写简单的内容,例如:
/// <summary>Builds a new string whose characters are the results of applying the function <c>mapping</c>
/// to each of the characters of the input string and concatenating the resulting
/// strings.</summary>
/// <param name="mapping">The function to produce a string from each character of the input string.</param>
///<param name="str">The input string.</param>
///<returns>The concatenated string.</returns>
///<exception cref="System.ArgumentNullException">Thrown when the input string is null.</exception>
val collect : (char -> string) -> string -> string
但是你可以在XML文档中嵌入图像吗?
答案 0 :(得分:2)
您可以在XML文档中包含<img ... />
和其他HTML标记。我刚试过这个,Visual Studio只是跳过图像(所以你不会在IntelliSense中看到它),但F#Power Pack中的fshtmldoc
工具只是将HTML标签复制到输出HTML文档,包括图像。
/// <summary>Hi <img src="http://tomasp.net/img/fpman.jpg" /> there!</summary>
type IMultiKey =
// (...)
给我以下生成的文档:
我认为C#编译器会对XML标记进行一些额外的验证,但我不认为这是在F#编译器中完成的。顺便说一句,我发现编写XML文档的时间非常长,所以我正在使用F# Formatting在Markdown中编写它们(但我还没有准备好任何东西)。