不包装长参数列表的可能理由是什么？ (StyleCop SA1115)

Question

我陷入了 ReSharper 和 StyleCop 之间的战斗，我想让 ReSharper 获胜，但在这样做之前我想听听支持 StyleCop 的论点。

当我编写长参数列表时，ReSharper 会明智地截断参数列表并在下一行重新启动它。 我发现这更具可读性。

当我对代码运行 StyleCop 时，它希望我将这些行保留得很长。 我不喜欢这样，所以我想忽略 StyleCop 规则 (SA1115)。 我想不出 SC 一开始想要排这么长队的好理由——这只是“我们一直都是这样做的”吗？

Answer 1

StyleCop 不希望您将所有参数放在很长的一行上。 但是，它也不希望您随意插入换行符以将参数列表的一部分向下移动到下一行。 StyleCop 希望您执行以下操作之一：

public void MyMethod(int param1, int param2, int param3)

public void MyMethod(
    int param1, int param2, int param3)

public void MyMethod(
    int param1,
    int param2,
    int param3)

Answer 2

它可能是为了提醒您，您的论点列表太长，应该缩短。

Answer 3

在使用此问题，我也通过从 VS IDE 运行 StyleCop 遇到了 SA1115 的问题。 经过一番思考后，StyleCop 觉得还不错的最终结果是：

public static string Format<T>(string pattern, T template)
{
    Dictionary<string, string> cache = new Dictionary<string, string>();

    return RegexExpression.Replace(
        pattern, 
        match =>
    {
        string key = match.Groups[1].Value;
        string value;

        if (!cache.TryGetValue(key, out value))
        {
            var prop = typeof(T).GetProperty(key);

            if (prop == null)
            {
                throw new ArgumentException("Not found: " + key, "pattern");
            }

            value = Convert.ToString(prop.GetValue(template, null));
            cache.Add(key, value);
        }

        return value;
    });
}

只是想分享一下。

Answer 4

似乎规则从技术上讲是“参数必须遵循逗号”。 如果你问我的话，我是相当挑剔的，但有些人相信用逗号开始续行才能真正显示嘿！ 这句话是一个延续！ 例如，

void Foo(  int blah
         , string blork
         , ...

无论你的船是什么，就个人而言:)