将文本格式标签添加到xml doc

时间:2014-03-13 13:04:35

标签: xml f# documentation-generation

我想知道是否可以将文本格式(布局)标签添加到xml doc。

例如:

...

/// <summary>
/// This method is <bold>important</bold> and it does: <%Go to a new line%>
/// - take an input <%Go to a new line%>
/// - produce an output </summary>
member this.MyMethod () = 

...

谢谢。

1 个答案:

答案 0 :(得分:1)

这取决于您用于生成文档的工具。 F#-compiler只是吐出你放在那里的任何标签。

原则上,源代码中的标记应该都是逻辑的,仅指示元素的功能。他们的演示应留给任何工具产生逻辑标记的输出。

也就是说,在C#中,添加<para>标签是实现换行的常用方法。对于您的特定示例,看起来<list>就是您所追求的。