一个好的代码规范直接影响代码的质量,今天给大家分享的内容如标题所示:C/C++命名规范。
命名约定
最重要的一致性规则是命名管理, 命名的风格能让我们在不需要去查找类型声明的条件下快速地了解某个名字代表的含义: 类型、变量、 函数、 常量、宏等。甚至,我们大脑中的模式匹配引擎非常依赖这些命名规则。
命名规则具有一定随意性, 但相比按个人喜好命名, 一致性更重要, 所以无论你认为它们是否重要, 规则总归是规则。
一、通用命名规则
1.总述
函数命名, 变量命名, 文件命名要有描述性; 少用缩写。
2.说明
尽可能使用描述性的命名, 别心疼空间, 毕竟相比之下让代码易于新读者理解更重要. 不要用只有项目开发者能理解的缩写, 也不要通过砍掉几个字母来缩写单词。
比如:
注意, 一些特定的广为人知的缩写是允许的, 例如用 i 表示迭代变量和用 T 表示模板参数。
模板参数的命名应当遵循对应的分类: 类型模板参数应当遵循类型命名的规则, 而非类型模板应当遵循变量命名的规则。
二、文件命名
1.总述
文件名尽量全部小写, 可以包含下划线 (_) 或连字符 (-), 依照项目的约定. 如果没有约定, 那么 “_” 更好。
2.说明
通常应尽量让文件名更加明确,bsp_i2c.h 就比 i2c