对于功能参数,我想使用代码文档中的选项列表。
对于<summary>
标记,这没有问题(Microsoft Docs)。但是,如何为<param>
标签创建项目符号列表?下面的示例在编程时不会在快速查看窗口中创建列表:
<param name="Type list">
<list type= "bullet">
<item><description>Item description</description></item>
</list>
</param>
这很好。
我尝试了这段代码:
public class Program
{
/// <summary>The summary</summary>
/// <param name="args">
/// The command-line arguments.
/// <list type="bullet">
/// <item><description>Item 1</description></item>
/// <item><description>Item 2</description></item>
/// <item><description>Item 3</description></item>
/// </list>
/// </param>
public static void Main(string[] args)
{
}
}
然后,我使用Sandcastle生成了一个如下所示的帮助文件:
如您所见,项目符号列表正确显示了该参数。
这是Resharper显示工具提示的方式:
本文收集自互联网,转载请注明来源。
如有侵权,请联系[email protected] 删除。
我来说两句