c# - 如何为具有 IDictionary 的函数制作文档范围？

Question

可能重复：
C#：如何在 xml 文档中引用泛型类和方法

我想为我的静态函数创建一个简短的文档（在 VS2010 中），它有一个IDictionary<TKey, TValue>参数。

例如 ：

public static string newDocument(IDictionary<string,string> listMap)
{
//the code
}

我想在 VS2010 中创建一个文档，当你键入/3 次之后会自动生成如下：

/// <summary>
/// create something
/// </summary>
/// <param name="listMap">Text here</param>
/// <returns></returns>
public static string newDocument(IDictionary<string,string> listMap)
    {
    //the code
    }

我想这样写：字典key是某种东西，字典value是另外一种东西。

怎么做 ？

Answer 1

StyleCop 规则指南不提供任何记录 IDictionaries 的规则。这很简单，但我建议如下：

/// <param name="listMap">List map parameter representing xxx. The keys in the dictionary are XXX and the values are YYY</param>