描述XML文档中泛型的通用

时间:2018-06-05 12:59:58

标签: c# xml-documentation xml-comments

在我的界面中,我有以下方法签名:

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

请建议

0 个答案:

没有答案