通用参数实现的XML文档

本文关键字:XML 文档 实现 参数 | 更新日期: 2023-09-27 18:10:07

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

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

记录T:"string"和T1:"string"含义的正确方法是什么?

编辑

我忘记在mycommand类定义中添加iccommand接口了。类没有重复,另一个问题问的是泛型参数T的文档,我问的是泛型参数T的实现文档

通用参数实现的XML文档

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