您如何为委托参数提供xml注释/文档?

时间:2010-02-12 23:01:04

标签: c# delegates comments

给出像

这样的代表
Func<string,string,string> MyFunc = (firstName,lastName) => string.Format("Given Name:{0} Surname:{1}",
                                                                            firstName,
                                                                            lastName);

你怎么能记录firstName和lastName的参数,所以它们出现在intellisense中(如方法描述和参数那样)?
例如:

/// <summary>
/// My Method
/// </summary>
/// <param name="firstName">The first name.</param>
/// <param name="lastName">The last name.</param>
/// <returns></returns> 
public string MyMethod(string firstName, string lastName)
{ 
  return string.Format("Given Name:{0} Surname:{1}",firstName,lastName);
}

我希望将鼠标悬停在委托上或在我输入时有智能感知弹出窗口并告诉我委托参数的描述,就像上面的方法一样。

1 个答案:

答案 0 :(得分:10)

委托类型的字段仍然是字段而不是方法 - 它本身不接受参数。参数属于委托类型,而不是委托字段。如果需要,可以在委派类型时编写参数注释。

/// <summary>
/// Tests something.
/// </summary>
/// <param name="test">Something that's going to be tested.</param>
delegate void Test(int test);

Func<string,string,string>是具有三个参数的函数的一般委托。出于特定目的,您可以始终声明自己的委托类型,更具体地表示抽象方法,并为其参数添加注释。