c# - Lambda 上的 Visual Studio 文档注释

Question

在带有函数的 C# 中，您可以像这样添加文档注释:

///<summary>
///
///</summary>
///<param name=""></param>
///<returns></returns>

当使用普通函数时，它会自动生成。然而，当使用 lambdas 时什么也没有发生。有没有办法将文档注释与 lambda 一起使用？

Answer 1

许多 lambda 表达式不需要您编写文档，因为它已经存在。

例如，如果您向 Where 子句提供 lambda 表达式，则函数已记录在案 here (虽然它没有很多细节):

predicate

Type: System.Func

A function to test each element for a condition.

我建议，如果您有一个扩展方法或其他类型的代码将 lambda 表达式作为参数，记录其输入和输出的适当位置是使用它的方法，而不是设置它的代码。

另一方面，如果您需要记录 lambda 的特定实现的内部工作原理(即它非常复杂)，我建议您将其实现为与签名匹配的标准 c# 方法。

因此而不是

Users
.Where( r => {
    DoSomethingComplicated();
    MoreCode();
    return FinalResult();
});

你只要写

Users.Where( MyFunction )

然后在别处定义函数:

/// <summary>
/// This function calls DoSomethingComplicated and MoreCode
/// </summary>
/// <returns> A Boolean specifying whether the user should be included </returns>
bool MyFunction(User user)
{
    DoSomethingComplicated();
    MoreCode();
    return FinalResult();
}