Func的首选命名约定是什么？方法参数？

Question

我承认这个问题是主观的，但我对社区的观点感兴趣。我有一个缓存类，它采用 Func 类型的缓存加载器函数，它使用该函数从数据库检索值并将其存储在缓存中。

public static class Cache
{
    public TResult Get<TResult>(string cacheKey, Func<TResult> cacheLoader) 
    {
        // Implementation
    }
}

我的问题是：我应该如何命名函数参数？

• 我应该将它命名为一个对象，例如cacheLoader吗？
• 我应该将其命名为方法，例如 loadResult 吗？
• 我是否应该明确将其称为函数，例如 cacheLoadFunction？ （我不喜欢这个。）

我对这个特定函数参数的命名不太感兴趣，而对一般如何命名函数参数更感兴趣。 Stack Overflow 社区对此有何看法？

Answer 1

在框架中使用名词是有先例的，例如，

Enumerable.Average<TSource>(this IEnumerable<TSource> source, Func<TSource, decimal?> selector)

Enumerable.Count<TSource>(this IEnumerable<TSource> source, Func<TSource, bool> predicate)

Enumerable.GroupBy<TSource, TKey, TElement>(this IEnumerable<TSource> source, Func<TSource, TKey> keySelector, Func<TSource, TElement> elementSelector)

ConcurrentDictionary<TKey,TValue>.GetOrAdd(TKey key, 
            Func<TKey, TValue> valueFactory);

名词通常是带有施事后缀。

在您的示例中，我将使用诸如 loader 或可能的 valueFactory 之类的东西。我个人不喜欢 cacheLoader 因为可能是调用者而不是委托执行在缓存中插入的工作。

Answer 2

我喜欢将其命名为方法，这样当您调用它时，就像这样：

loadResult(result);

它看起来像普通的方法调用，但大小写表明它是一个变量，因此两条信息都被传达。

您可以附加诸如 Method 或 Delegate 或 Lambda 之类的后缀，但这些后缀通常只会使其变得冗长而不会增加清晰度。这可能取决于具体情况和您的编码标准，当然还有您的偏好。

Answer 3

我通常在命名中使用“委托”一词，以表明此参数正在接收委托。例如，我可能会命名上述内容：

public static class Cache
{
    public TResult Get<TResult>(string cacheKey, Func<TResult> cacheLoadingDelegate) 
    {
        // Implementation
    }
}

我这样做是为了避免与问题中建议的命名产生混淆。 cacheLoader 听起来太像一个对象，而 loadResult 听起来太像一个对象/类型（结果本身）。我个人也不喜欢使用 function 或 method，因为委托实际上不是函数，而是委托 - 引用函数的类型。