Подробная XML-документация для поля.Возможно ли это? - PullRequest
Новая
       25

Подробная XML-документация для поля.Возможно ли это?

2 голосов
/ 15 ноября 2010

Я определил поле обратного вызова и свойство события для него: 

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>

Спасибо!

1 Ответ

1 голос
/ 15 ноября 2010

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