“ 能始终做自己的人, 是因为得到了太多的温柔善意。”
2019. 整理一篇Google的C++ 编程规范~
中文版:https://zh-google-styleguide.readthedocs.io/en/latest/google-cpp-styleguide/contents/#c
Google 的C++ 编码规范很早就已经公开了,李开复也在其微博上公开分享:”我认为这是地球上最好的一份C++编程规范,没有之一,建议广大国内外IT研究使用。“
下面重点说一下命名的规范:
1. 通用命名规则
Tip
函数命名,变量命名,文件命名要有描述性;少用缩写。
尽可能给有描述性的命名,别心疼空间,毕竟让代码易于新读者理解很重要。不要用只有项目开发者能理解的缩写,也不要通过砍掉几个字母来缩写单词。
int price_count_reader; // 无缩写 int num_errors; // “num” 本来就很常见 int num_dns_connections; // 人人都知道 “DNS” 是啥
Warning
int n; // 莫名其妙。 int nerr; // 怪缩写。 int n_comp_conns; // 怪缩写。 int wgc_connections; // 只有贵团队知道是啥意思。 int pc_reader; // "pc" 有太多可能的解释了。 int cstmr_id; // 有删减若干字母。
2. 文件命名
Tip
文件名要全部小写, 可以包含下划线 (_
) 或连字符 (-
). 按项目约定来. 如果并没有项目约定,”_” 更好。
可接受的文件命名:
* my_useful_class.cc * my-useful-class.cc * myusefulclass.c