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

Posted 2023-02-21

【中文标题】您如何为委托参数提供 xml 注释/文档？

【英文标题】：How do you provide xml comments/documentation for delegate parameters?

【发布时间】：2011-01-16 09:00:37

【问题描述】：

给定一个像

这样的代表

Func<string,string,string> MyFunc = (firstName,lastName) => string.Format("Given Name:0 Surname:1",
                                                                            firstName,
                                                                            lastName);

您如何记录 firstName 和 lastName 的参数，以便它们显示在智能感知中（就像方法描述和参数一样）？ 示例：

/// <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】：

委托类型的字段仍然是字段而不是方法——它本身不带参数。参数属于委托type，而不是委托field。如果需要，可以在委托类型时为参数编写 cmets。

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

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

【讨论】：

太糟糕了，没有办法为Func<string,string,string> 提供intellisense 的文档。并且对传入和返回的内容有特定的期望。