0

In my interface I have the following method signature:

ServiceResponse<IDictionary<int, string>> Dictionary(DictionaryRequest request);

I'm trying to add XML comment for that method like:

/// <summary>
///     Returns the dictionary of all codes with translations for the requested language.
/// </summary>
/// <param name="request">The <see cref="DictionaryRequest"/> containing the incoming parameters.</param>
/// <returns>An <see cref="ServiceResponse{IDictionary{TKey, TValue}}"/> containing codes and values of translations.</returns>
ServiceResponse<IDictionary<int, string>> Dictionary(DictionaryRequest request);

What is the proper way to do that? Should I specify type like

<see cref="ServiceResponse{IDictionary{int, string}}"/>

or it is enough

<see cref="ServiceResponse{T}"/>

or

<see cref="T:ServiceResponse&lt;IDictionary&lt;int, string&gt;&gt;"/>

Please suggest

Robert N. Dean
  • 1,219
  • 1
  • 14
  • 27

0 Answers0