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>是一个委托类型，它带有三个参数您可以为该字段编写XML文档注释，但这仅适用于字段本身。

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

例如：

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

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

1 个答案: