代码中的变量定义原则

本文中，我们将深入探讨代码中的变量定义原则，旨在帮助读者提升代码的可读性和维护性。我们将从变量命名的规范性、变量作用域的划分、变量类型的选择以及常量与变量的区分等多个方面展开论述，并结合具体案例进行分析。通过遵循这些原则，你将能够编写出更加清晰、易于理解的代码，提高团队协作效率，降低出错率。无论你是初学者还是资深开发者，本文都将为你提供宝贵的指导，助你在代码编写中更上一层楼。 

1. 命名规则

• 变量名即反应变量的含义；

• 变量名只能是字母，数字和下划线的组合，不建议使用特殊字符；
• 关键字不能用作变量名；
• 使用英文单词或缩写组成变量名，不建议使用汉语拼音或其它语言；

2. 命名习惯

• 驼峰体，如AgeOfOlodboy=35，NumberOfOldboy=80；
• 下划线体，如age_of_oldboy=35，number_of_oldboy=80

3. 注释

• 建议每个变量都有注释，用于解释变量的含义，尤其变量不能准确反应变量属性的情况下；
• 物理量的单位一定要注明。这是非常容易出错的地方，物理量的单位最好注释在代码中而非写一个文档；
• 物理量的坐标系或坐标原点要注明，这也是很容易出错的地方，建议坐标系写在代码中而非文档中；

参考文献

https://www.cnblogs.com/chenjiao0904/p/9592507.html