对于函数参数,我是否要使用代码文档中的选项列表。对于<summary>
标签,这是没有问题的(MSDN Summary List)。但我如何为<param>
标记制作一个bullit列表呢?下面的示例在编程时不会在QuickView窗口中创建列表:
<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显示工具提示的方式:
关于c# - 代码文档的PARAM部分中的C#项目符号列表,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/27291560/