Опишите родовое из дженерика в документациях XML - PullRequest
Новая
       38

Опишите родовое из дженерика в документациях XML

0 голосов
/ 05 июня 2018

В моем интерфейсе у меня есть следующая сигнатура метода: 

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

Я пытаюсь добавить комментарий XML для этого метода, например: 

/// <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);

Какой правильный способсделай это?Должен ли я указать тип типа 

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

или достаточно 

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

или 

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

Пожалуйста, предложите

...