高质量C/C++变量函数命名规则
在软件开发中,命名规则是一项非常重要的规范。好的命名规则可以提高代码的可读性和维护性,而坏的命名规则则会导致代码难以理解和维护。在C/C++语言中,变量函数命名规则是非常重要的。以下是关于高质量C/C++变量函数命名规则的知识点:
规则 1:标识符应当直观且可以拼读
在命名变量和函数时,应当使用直观且可以拼读的标识符。这可以提高代码的可读性和维护性。例如,使用英文单词或其组合,可以采用 camelCase 或 underscore 分隔符。切忌使用汉语拼音来命名,因为这样可能会导致代码难以理解。
规则 2:标识符的长度应当符合“min-length && max-information”原则
标识符的长度不是越长越好,而是要精简,一看就能明白变量和函数的意思和作用。例如,变量名 maxval 就比 maxValueUntilOverflow 好用。单字符的名字也是有用的,常见的如 i, j, k, m, n, x, y, z。
规则 3:命名规则尽量与所采用的操作系统或开发工具的风格保持一致
在命名变量和函数时,应当尽量与所采用的操作系统或开发工具的风格保持一致。例如,Windows 应用程序的标识符通常采用“大小写”混排的方式,如 AddChild。Unix 应用程序的标识符通常采用“小写加下划线”的方式,如 add_child。
规则 4:程序中不要出现仅靠大小写区分的相似的标识符
在命名变量和函数时,应当避免出现仅靠大小写区分的相似的标识符。这样可以避免代码的混淆和困惑。
规则 5:程序中不要出现标识符完全相同的局部变量和全局变量
在命名变量时,应当避免出现标识符完全相同的局部变量和全局变量。尽管两者的作用域不同,但这样做可以避免代码的混淆和困惑。
规则 6:变量的名字应当使用“名词”或者“形容词+名词”
在命名变量时,应当使用“名词”或者“形容词+名词”。例如:float value; float oldValue; float newValue;
规则 7:全局函数的名字应当使用“动词”或者“动词+名词”
在命名全局函数时,应当使用“动词”或者“动词+名词”。类的成员函数应当只使用“动词” ,被省略掉的名词就是对象本身。
规则 8:用正确的反义词组命名具有互斥意义的变量或相反动作的函数等
在命名变量和函数时,应当使用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如:int minValue; int maxValue; int SetValue(…); int GetValue(…);
建议 9:尽量避免名字中出现数字编号
在命名变量和函数时,应当尽量避免名字中出现数字编号,除非逻辑上的确需要编号。这可以避免程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字。
- 1
- 2
前往页