通用参数实现的XML文档?

时间:2013-04-19 17:08:52

标签: c# xml-documentation

给定一个通用接口,我如何记录泛型类型的实现?

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

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

什么是记录T的意思的正确方法:“string”和T1:“string”?

修改

我忘了将ICommand接口添加到MyComand类定义中。该类没有重复,另一个问题是关于通用参数T的文档,我在询问有关泛型参数T的实现的文档。

1 个答案:

答案 0 :(得分:3)

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