Question

可能重复：
C#: How to reference generic classes and methods in xml documentation

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

例如：

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

我想在VS2010中创建一个文档，当您键入/三次时，会自动生成，如下所示：

/// <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 rules guide并未提供任何记录身份的规则。这很简单，但我建议如下：

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

如何为具有IDictionary <tkey，tvalue =“”>参数的函数创建文档？</tkey，>

1 个答案: