使用大括号来实现可变作用域是错误的吗？

Question

我有时使用大括号来隔离代码块，以避免以后错误地使用变量。例如，当我将多个 SqlCommand 放入同一个方法中时，我经常复制粘贴代码块，最后混合名称并执行两次某些命令。添加大括号有助于避免这种情况，因为在错误的位置使用错误的 SqlCommand 会导致错误。下面是一个示例：

Collection<string> existingCategories = new Collection<string>();

// Here a beginning of a block
{
    SqlCommand getCategories = new SqlCommand("select Title from Movie.Category where SourceId = @sourceId", sqlConnection, sqlTransaction);
    getCategories.Parameters.AddWithValue("@sourceId", sourceId);
    using (SqlDataReader categoriesReader = getCategories.ExecuteReader(System.Data.CommandBehavior.SingleResult))
    {
        while (categoriesReader.Read())
        {
            existingCategories.Add(categoriesReader["Title"].ToString());
        }
    }
}

if (!existingCategories.Contains(newCategory))
{
    SqlCommand addCategory = new SqlCommand("insert into Movie.Category (SourceId, Title) values (@sourceId, @title)", sqlConnection, sqlTransaction);

    // Now try to make a mistake and write/copy-paste getCategories instead of addCategory. It will not compile.
    addCategory.Parameters.AddWithValue("@sourceId", sourceId);
    addCategory.Parameters.AddWithValue("@title", newCategory);
    addCategory.ExecuteNonQuery();
}

现在，每当块后面有一个空行时，StyleCop 就会显示一条警告。另一方面，不放置空行会使代码更难理解。

// Something like:
Collection<string> existingCategories = new Collection<string>();
{
    // Code here
}

// can be understood as (is it easy to notice that semicolon is missing?):
Collection<string> existingCategories = new Collection<string>()
{
    // Code here
}

那么，

1. 仅出于变量作用域的目的使用大括号创建代码块是否存在问题？

2. 如果没问题，如何在不违反StyleCop规则的情况下使其更具可读性？

Answer 1

阻止代码本身并没有什么问题，但您需要考虑为什么要这样做。

如果您要复制和粘贴代码，则可能会遇到这样的情况：您应该重构代码并生成重复调用的函数，而不是重复执行相似但不同的代码块。

Answer 2

使用 using 语句而不是裸括号块。

这将避免警告，并且还可以使您的代码在资源方面更加高效。

从更大的角度来看，您应该考虑将此方法拆分为更小的方法。使用一个 SqlCommand 后跟另一个 SqlCommand 通常最好的方法是调用一种方法，然后调用另一种方法。然后，每个方法将使用自己的本地 SqlCommand。

Answer 3

我不认为纯粹使用大括号来界定范围有什么问题——它有时非常有用。

举个例子 - 我曾经遇到过一个分析库，它使用 Profile 对象来对代码段进行计时。它们的工作原理是测量从创建到销毁的时间，因此在堆栈上创建然后在超出范围时销毁，从而测量在该特定范围内花费的时间，效果最佳。如果您想要对本身没有自己的范围的东西进行计时，那么添加额外的大括号来定义该范围可能是最好的方法。

至于可读性，我可以理解为什么 StyleCop 不喜欢它，但是任何有 C/C++/Java/C#/... 经验的人都知道大括号对定义了一个范围，并且应该相当明显，这就是你正在尝试做的事。

Answer 4

我认为这样的块是个好主意，我经常使用它们。当您需要将太小而无法提取到方法中的代码块分开时，或者当方法由几个彼此看起来相似但逻辑不同的代码块组成时，它非常有用。它允许给变量赋予相同的名称而不会发生命名冲突，这使得方法体更具可读性。

顺便说一句，我认为 StyleCop 有默认规则集，其中包含更多规则，其便利性值得商榷。

Answer 5

我不得不说，如果我在你之后处理这段代码，我会对你使用范围感到有点反感。据我所知，这不是常见的做法。

我认为你这样做有一种气味。我认为更好的做法是将每个范围分解为具有完全描述性名称和文档的自己的方法。