代码之家 › 专栏 › 技术社区 › Bless Yahu

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

comments delegates c#

8

Bless Yahu · 技术社区 · 16 年前

给一个代表

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

当我键入并告诉我委托参数的描述时,我希望将鼠标悬停在委托上或弹出IntelliSense,就像上面的方法一样。

1 回复 | 直到 16 年前

1

10

Mehrdad Afshari 16 年前

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

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

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