有关字段的详细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向我展示IntelliSense时，我的方法需要(int arg1, int arg2, TaskCallbackArgs arg3)参数。 当我在一段时间后打开这段代码时，我不记得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);