《Clean Code》指出:好的代码本身就是注释,我们要尽量规范和美化自己的代码来减少不必要的注释。若编程语言足够有表达力,就不需要注释,尽量通过代码来阐述。
本文记录了一些编程时常用的命名规则及应用场景。
图1-1 C++编程命名规范
命名易读性规范
1. 尽量不要缩写/简写单词,除非这些单词已经被公认可以被这样缩写/简写。
2. 可读性强的名字优先于简短的名字,虽然可读性强的名字会比较长一点。
3. 避免无意义的命名,你起的每一个名字都要能表明意思。
4. 避免命名过长(50 个字符以内最好),过长的命名难以阅读并且丑陋。
5. 不要使用拼音,更不要使用中文。 注意:像 baidu 这种国际通用名词可以当做英文来看待。
推荐阅读
1. Google C++ Style Guide。谷歌的 C++ 编程规范,在国内有较大影响力,是企业级规范,对代码的具体样式有细致的规定,可直接采用。
2. MISRA C/C++。在嵌入式开发领域有较高认可度,是行业级规范,企业可直接采用。