Как создать документацию для функции, которая имеет параметр IDictionary <TKey, TValue>?

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>