您是否在任何地方都使用 1-3 个字母的变量？ [关闭]

Question

我注意到，在 C# 中，我在任何地方都使用非常短的变量名。我的代码被污染了

foreach(var (v|f|i) in SOMETHING)

for(int (i|n|z)=0

var (ret|r) = blah();
...
return ret;

var sw = new StringWriter();

using(var r = cmd.ExecuteNonQuery()) {
    while(r.Read()) {
        r.GetSomething(3)

我不知道这是坏还是好的。我当然可以阅读它。我 5 个月前或更早之前没有看过代码，所以我不能说我是否理解旧代码。我所有的函数都很短，只做一件事，所以通过阅读函数，您可以很好地了解变量是什么，特别是因为函数中有

人们过去常常对我大喊不使用好的变量名。我没有使用好的变量名还是可以？

Answer 1

编写供人类阅读的代码。 一个好的经验法则是变量的使用范围越大，其名称就应该更具描述性。函数参数尤其应该具有非常具有描述性的名称，但参数作用显而易见的函数除外，如
double sqrt(double n)

但是，如果它通常是一个短名称并在小范围内使用，那么请使用短名称。示例：

//these are okay
var sb = new StringBuilder();
var sw = new StringWriter();
var cmd = new SqlCommand();
for(var i = 0; i< count; i++) {}

Answer 2

除非您的代码被缩小，否则您不应该到处看到这样的变量。您的代码应该易于理解。

我记得听说我们应该把所有的代码都当作下一个管理我们项目的人是一个知道你住在哪里的精神病杀手。

Answer 3

对局部变量使用短变量名是可以的，只要范围有限。

就个人而言，我发现对于简单的使用而言，简短的变量名称往往比较长的变量名称更易于阅读。

using (StreamReader sr = new StreamReader(inputStream))
{
    sr.ReadByte();
} 

相对于：

using (StreamReader streamReader = new StreamReader(inputStream))
{
    streamReader.ReadByte();
} 

这真的是关于可读性。每种情况都不同，开发团队也不同。遵循项目的编码标准（如果存在）。如果没有，请遵循现有代码库的样式（如果存在）。

我同意这里的一些答案，即变量名称应该有好的名称。但我相信这是假设一个对象具有 semantic 价值。有时，它不会。在某些情况下，您只需要一个特定对象的实例来执行一些小任务，之后它就变得无关紧要了。在这种情况下，我认为缩写标识符是可以接受的。

注意：仅仅因为变量的使用在其范围内受到限制并不一定意味着无意义的名称是可以的。如果有一个好的名称可以代表对象的功能，那么应该使用它。如果你能想出一个变量名来回答“为什么？”，那么这个名字就更可取了。

此外，开发人员非常了解使用“i”和“j”作为for 索引。按照惯例，loop counter variables have been named this way 自 FORTRAN 时代以来。

for (int i = 0; i < 10; i++)
{
    for (int j = 0; j < 10; j++)
    {
        PerformOperation(i,j);
    }
}

Answer 4

几年前，我发现如果我将函数缩短会发生什么：

• 我能理解它们。我的大脑很小，长功能不适合。

• 类变得复杂（很多功能）。但是 Extract Class 产生了小的、有凝聚力的、单一用途的类。再说一次，小脑袋，所以需要小班。

• 函数（或类）中的变量数量很少。从声明时间到使用时间，记住哪个是哪个很容易，因为距离很短。

• 我的函数中作用域的数量很少，所以我不必弄清楚哪些变量放在哪里。

有了所有这些，我如何命名变量并不重要。这些名称不必弥补难以理解的代码。

由于作用域中的变量数量很少，而且目的很明显，所以我很少需要花任何精力来选择描述性名称。因为我不想让我的小脑袋过度劳累，所以我从不缩写。我的变量默认名称是类型的名称。例如。类Foo 进入变量foo。在我的代码中，如果它有任何不同，你就知道发生了一些特别的事情，你应该注意。

在过去，我不使用缩写的习惯会产生笨拙的代码，但由于我的方法和类很小，所以代码不会受到影响。

Answer 5

这不仅仅是一个好的变量名称的问题（这是一个好主意），而是如果其他人可以依靠 cmets 以及 变量名称。

当然，对于诸如计数器或简单动作之类的东西，简短而简洁的名称是有意义的。对于更复杂的算法或更难阅读的内容，您需要详细说明代码清晰。

每个商店和每个开发者都是不同的。在一天结束的时候，尝试为下一个可能需要维护它的人编写代码，考虑。

Answer 6

在循环或定义良好的短块中使用一个字母的变量名作为索引通常被认为是可以的。但是，对于诸如函数参数和局部变量之类的事情，使用描述性的骆驼案例名称可以向阅读您的代码的其他人传达含义并没有错。

Answer 7

除了有限的例外，不 - 这是不行的。单个字母或过度缩写的变量名称不再是任何借口。即使您是一个打猎和啄食的打字员，智能感知也意味着您几乎不需要拼写任何内容。如果您继续以这种方式命名变量，那么您就是在惩罚自己任何不幸被委派维护您的代码的人。

Answer 8

我会认为这是一种糟糕的编码风格吗？嗯，是的。

如果您与我一起处理相同的代码，我会反复提醒您更好地命名变量。简而言之，好的代码应该可以被其他开发人员轻松阅读，而好的变量名会大有帮助。也许你在阅读你的代码一段时间后也不会遇到问题，但问题是从未从事过这种工作的人是否也能接受它。

有一些例外情况我认为短变量名是可以的：

索引（主要在 for 循环中），例如：

for (int i = 0; i < 10; i++)
{
}

在非常有限的范围内使用的变量，例如 Linq 查询、lambda 表达式或已经提到的一些示例，例如 Streamwriters 和 -readers 等，这是我认为短变量名很好的另一个示例。

此外，您的代码最终的可读性始终是一个问题。我经常对使用短变量名的人唠叨的原因是，对我来说，这表明他们通常不关心他们的代码的可读性（尤其是对其他人而言）。

Answer 9

我不知道当你有这样的变量名时如何跟踪事情。

通常，使用更长的名称来实际描述变量会更好。要努力的事情是让任何人都能够阅读代码并理解发生了什么，能够理解它们的用途等等 =)

Answer 10

我的变量名称的平均长度似乎每年我编写（更重要的是阅读）代码的时间都会增加一倍。

Answer 11

只需查看几行代码，就应该立即清楚任何变量的用途。这可能是由于一个好的变量名或上下文。

关于我唯一使用短变量名的情况是，如果短名称是完全描述性的（即，在处理坐标的情况下，x & y）或者它是一个对数据类型进行操作的实用函数（即，大写这个字符串的第一个字母。它是一个字符串，你还能说什么？我把它命名为S。）

Answer 12

我可能不知道代码后面的“r”是什么。此外，变量名是一回事，但您应该为详细解释注释代码。 注意：这应该是一个社区 wiki，因为没有明确的答案。

Answer 13

这很糟糕。这是无法维护的。

短变量有它们的位置。真的没有理由写 for(int 迭代器；迭代器

经验法则是：每个屏幕可触及一个字母。具有标准化的 24 行屏幕。

例外情况是选择一两个非常常用的全局变量或半全局变量，例如指向数据存储的指针或输入数据指针，并使它们的长度为 1-3 个字母。但除此之外 - 使用理由。短循环 - 一个字母。函数的局部变量 - 3-5 个字母。类变量 - 完整的单词。库类/函数名称 - 两个词。

Answer 14

我看不出有任何理由使用无意义的短变量名。我们生活在 21 世纪，我们拥有带有 IntelliSense（或其他自动完成功能）的 IDE！只需按 Ctrl+Space，它会根据变量类型为您的变量提供 正常 名称，例如

StringBuilder <Ctrl+Space> stringBuilder;
List<Person> <Ctrl+Space> persons;

这比键入 sb 或其他短名称更容易。没有理由再使用短名称了。

P.S.：对我来说唯一的例外是 for 循环中的 i, j, k 之类的计数器。

Answer 15

我更喜欢结合描述性 cmets 的简短“神秘”变量（符号，在 Mathematica 中）。

Mathematica 已经为内置命令提供了 VeryLongFunctionNames，添加我自己的代码通常会使代码展开超出我的关注范围。

我发现阅读更短的代码块更容易，我可以一次看到所有内容以及一系列符号描述。