C# SqlCommand 命名约定

Question

我对使用 C# 和 ASP.NET 还很陌生，我很好奇在 SQL 数据库上运行多个查询时是否有命名 SqlCommands 的约定。例如，我创建了我的 SqlConnection，我希望调用一个函数、两个存储过程，然后只创建一个常规的简单查询。目前，我正在使用：

SqlCommand function = new SqlCommand();
SqlCommand command = new SqlCommand();
SqlCommand proc1 = new SqlCommand();
SqlCommand proc2 = new SqlCommand();

这些不同的命令是否有更可接受的命名约定，或者我应该只使用一个命令，因为我在后面的代码块中使用 CommandText 和 CommandType 调用？

Answer 1

一个好的和更易读的约定是表达命令将做什么。 如果您阅读 updateProductCommand 或 queryCategoryCommand，每个人都会立即知道该命令的用途。 当您以存储过程为目标时，最好使用 sproc 名称作为命令前缀，例如 sp_UpdateProductCommand。

Answer 2

如果您在同一范围内有很多命令，则可以使用personCommand 或productCommand 之类的名称。从MSDN General Naming Conventions 你可以：

请选择易于阅读的标识符名称。例如，一个属性 命名为 Horizo​​ntalAlignment 比英文更易读 对齐水平。

更倾向于可读性而不是简洁。该物业 名称 CanScrollHorizo​​ntally 比 ScrollableX 好（一个不起眼的 参考 X 轴）。

请勿使用下划线、连字符或任何 其他非字母数字字符。 X 不要使用匈牙利符号。

避免使用与广泛使用的关键字冲突的标识符 编程语言。

查看更多关于C# Coding Conventions。在其他情况下，我更喜欢只使用command 到Keep It Simple，因为范围会告诉我。

另一个好技巧，当您使用实现了IDisposable 接口的类型（如SqlCommand、SqlConnection）时，您可以使用using() { } 结构在此范围之后处理对象。示例：

public IEnumerable<Person> GetPersons()
{
    var result = new List<Person>();

    using (var connection = new SqlConnection("connection string"))
    {
       // I know it is a person command, because it is in a method for it.
       // Keep it simple!
       using (var command = new SqlCommand("select id, name from persons", connection))
       {
          using (var reader = command.ExecuteReader())
          { 
              while (reader.Read())
              {
                  result.Add(new Person() {
                     Id = (int) reader["id"];
                     Name = reader["name"] as string;                    
                  });
              }
          } // reader is disposed here
       } // command is disposed here
    } // connection is disposed here

    return result;
}

还有更多关于编码约定的内容。请参阅参考资料中的链接。