XML-документация по реализации универсального параметра?

Учитывая универсальный интерфейс, как я могу задокументировать реализацию универсальных типов?

public interface ICommand<in T, in T2>
{
  void Execute(T arg1, T2 arg2);
}

public class MyCommand : ICommand<string, string>
{
}

Как правильно задокументировать значение T: «строка» и T1: «строка»?

РЕДАКТИРОВАТЬ

Я забыл добавить интерфейс ICommand к определению класса MyComand. Класс не дублируется, другой вопрос касается документации общего праметра T, я спрашиваю о документации реализации универсального параметра T.


c# xml-documentation
person nohros    schedule 19.04.2013    source источник
comment
В интерфейсе или в классе?   -  person SLaks    schedule 19.04.2013
comment
В базовом классе: MyCommand   -  person nohros    schedule 19.04.2013

Ответы (1)


arrow_upward
3
arrow_downward 

public class MyCommand<string, string>

Он не будет компилироваться.

В объявлении параметра типа можно указать только идентификаторы (T, T1, TKey и т. Д.). Однако вы можете предоставить XML-комментарии для параметров типа следующим образом.

/// <summary>
/// Description
/// </summary>
/// <typeparam name="T">The type of xxxx</typeparam>
/// <typeparam name="T2">The type of xxxx</typeparam>
public interface ICommand<in T, in T2>
{
  void Execute(T arg1, T2 arg2);
}
person Saeed    schedule 19.04.2013
comment
В моем вопросе есть ошибка, очень сожалею об этом и спасибо за ваш ответ, но я хочу знать, как задокументировать параметры класса MyComand, а не параметры интерфейса ICommand. - person nohros; 20.04.2013
comment
Вы не можете. Поскольку MyCommand не является универсальным типом, вы не можете задокументировать параметры. Проверьте дизайн своего кода, переосмыслите то, что вы действительно хотите. - person Saeed; 24.04.2013