c# - 字段的详细 XML 文档。有可能吗？

Question

我已经为它定义了一个回调字段和事件属性:

private Action<int, int, TaskCallbackArgs> _callbackEvent    
/// <summary>
/// Provides a callback event for task.
/// </summary>
public event Action<int, int, TaskCallbackArgs> CallbackEvent
{
  add
  {
    _callbackEvent += value;
  }
  remove
  {
    _callbackEvent -= value;
  }
}

在我的代码中，我调用了 _callbackEvent。好吧，但是当我键入 _callbackEvent( 时，VS 向我显示我的方法需要 (int arg1, int arg2, TaskCallbackArgs arg3) 参数的 IntelliSense。一段时间后当我打开这段代码时，我不记得什么是 arg1、arg2 和 arg3。

有没有一种方法可以像下面这样对字段使用 XML 文档？

/// <summary>
/// Description
/// </summary>
/// <param name="current">Param description...</param>
/// <param name="total">Param description...</param>
/// <param name="additional">Param description...</param>

谢谢!

Answer 1

Action<int, int, TaskCallbackArgs>是一个接受三个参数的委托(delegate)类型。
您可以为该字段编写 XML 文档注释，但这只会应用于该字段本身。

要为委托(delegate)参数添加参数名称和文档注释，您需要创建自己的委托(delegate)类型。

例如:

/// <summary>
/// Description
/// </summary>
/// <param name="current">Param description...</param>
/// <param name="total">Param description...</param>
/// <param name="additional">Param description...</param>
public delegate void CallbackHandler(int current, int total, TaskCallbackArgs additional);