3

Possible Duplicate:
C#: How to reference generic classes and methods in xml documentation

I want to create a short documentation (in VS2010) for my static function which has one IDictionary<TKey, TValue> parameter.

for example :

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

I want to create a documentation in VS2010 ,when you type / three times then will generate automatically like as below :

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

I want to write in this way: the dictionary key is something and the dictionary value is something else.

How to do that ?

Community
  • 1
  • 1
Snake Eyes
  • 16,287
  • 34
  • 113
  • 221

1 Answers1

1

The StyleCop rules guide doesn't not provide any rule for documenting IDictionaries. It's trivial, but I suggest the following:

/// <param name="listMap">List map parameter representing xxx. The keys in the dictionary are XXX and the values are YYY</param>
Daniel Peñalba
  • 30,507
  • 32
  • 137
  • 219