4.2.6 变量命名是否应该有描述？

[GreyZeng]

【4.2.6】命名 P72

避免过多的描述。例如一个变量是游戏中最后出现的“大 boss” ，不用写 theFinalBattleMostDangerousBossMonster, 可以直接写 boss。

在本章节中，作者介绍了编写代码的部分相关规范。作者指出变量命名不应该有过多描述，对这个观点我持怀疑态度。

查阅资料发现，作为经典命名法的匈牙利命名法，其基本原则是：变量名=属性+类型+对象描述。可见软件开发中描述变量是极为重要的，书中所说的可以直接写boss以个人理解是存在一些问题的。

对于工程开发而言，绝多数代码量都会在几千行甚至上万行，这个量级的代码往往包含大量的内容，而且通常不会由一两个人开发。而一个游戏中难道只会有一个boss吗？答案显然是否定的，如果以书中命名方式，每个boss不加以描述，那么同样的代码在不同开发人员眼中就会产生严重的歧义，这带来的影响是不言而喻的。

再以笔者本人开发经验为例，在上学期《编译技术》课程课设的开发中，我在开发前期和后期将两个不同变量都命名为token，所幸全部代码均由自己编写，对代码比较熟悉，才没有造成难以发现的bug。然而试想一下如果同样量级的代码由多个人进行合作开发，对变量命名再不加以描述，这显然会阻碍开发进度。
————————————————
版权声明：本文为CSDN博主「Kazeya」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/Kazeya/article/details/129206616

[GreyZeng]

变量命名应该具备描述性，以便在代码中更好地理解和维护。良好的变量命名可以提高代码的可读性和可维护性，清晰地表达变量所代表的含义和性质。

为此，需要选择能够准确描述变量用途和含义的名称。避免使用单个单词或不相关的缩写作为变量名。例如，使用"customerName"而不是"name"，或使用"totalSales"而不是"ts"。

虽然描述性的变量命名有助于代码的可读性，但也要注意不要过度冗长。变量名应该足够描述，同时保持简洁和易于理解。找到一个平衡点，确保变量名称清晰明了，并且不会给代码的可读性带来负面影响。
————————————————
版权声明：本文为CSDN博主「Kazeya」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/Kazeya/article/details/131275528