阅读 89

EasyC++03, C++谷歌代码风格规范

变量规范

C++当中变量的声明由变量类型 + 变量名组成。

关于C++的命名有几种规则:

  • 名称中只能使用字母、数字和下划线

  • 名称的第一个字符不能是数字

  • 大小写敏感

  • 不能使用C++关键字(如class、void等)

  • 用户自定义的标识符中不能连续出现两个下划线,也不能以下划线紧跟大写字母开头,此外定义在函数体外的标识符不能以下划线开头

  • C++对于名称长度没有限制,但部分平台有限制

对于初学者来说,由于编写的代码以及阅读的代码总量不够,对于什么是合理、完善的编码规范往往是比较困惑的。对于这点,我们可以参考谷歌的C++编码规范。

总则

总的原则是尽可能使用描述性的命名,不吝啬变量长度,因为相比之下让代码容易理解比容易敲出来更重要。

我们分别来看几个正面例子和反面例子,首先是正面例子:

int price_count_reader;    // 无缩写 int num_errors;            // "num" 是一个常见的写法 int num_dns_connections;   // 人人都知道 "DNS" 是什么 复制代码

这三个变量名的优点也已经写在注释里了,无让人歧义的缩写,变量名含义充分。再来看几个反面例子:

int n;                     // 毫无意义. int nerr;                  // 含糊不清的缩写. int n_comp_conns;          // 含糊不清的缩写. int wgc_connections;       // 只有贵团队知道是什么意思. int pc_reader;             // "pc" 有太多可能的解释了. int cstmr_id;              // 删减了若干字母. 复制代码

主要原因是掺入了太多的缩写,导致可读性几乎为零,不仅别人读不懂,就连写出这个代码的作者很快也会忘记它原本的含义。

文件命名

文件名全部要小写,可以包含下划线以及字符-,最好使用下划线。

比如:my_class.ccmyclass.cc等,这个只是谷歌的标准,使用.cpp后缀也是可以的,只要统一就行。

类型命名

类型命名采用大驼峰命名,不包含下划线,如:MyExcitingClassHelloWorldClass等。

所谓类型命名包括类,结构体,类型定义(typedef),枚举,类型模板参数,它们均使用相同的约定。即大写字母开头,每个单词的开头也为大写,即大驼峰。

如:

// 类和结构体 class UrlTable { ... class UrlTableTester { ... struct UrlTableProperties { ... // 类型定义 typedef hash_map<UrlTableProperties *, string> PropertiesMap; // using 别名 using PropertiesMap = hash_map<UrlTableProperties *, string>; // 枚举 enum UrlTableErrors { ... 复制代码

变量命名

C++的变量没有像Java一样遵循小驼峰,而是一律小写,单词和单词之间以下划线连接。

如:

string table_name;  // 好 - 用下划线. string tablename;   // 好 - 全小写. string tableName;  // 差 - 混合大小写 复制代码

但如果是类中的数据成员(成员变量),则变量的末尾需要额外的下划线:

class TableInfo {   ...  private:   string table_name_;  // 好 - 后加下划线.   string tablename_;   // 好.   static Pool<TableInfo>* pool_;  // 好. }; 复制代码

但结构体除外,仍然和普通变量一样命名。

struct UrlTableProperties {   string name;   int num_entries;   static Pool<UrlTableProperties>* pool; }; 复制代码

C++的变量命名方法类似Python区别于Java,对于学过Java的同学来说可能有些别扭。

常量命名

声明为constexprconst的变量,或者是其他没有显示定义但是在程序运行当中保持不变的,命名是以k开头,并且大小写混合,如:

const int kDaysInAWeek = 7; 复制代码

函数命名

函数命名同样遵循大驼峰命名法,即首字母以及每个单词首字母大写。

对于特殊的缩写单词,通常将它们视作是普通单词,而不会全部大写,如:

void GetUrl(); // 正确 void GetURL(); // 错误 复制代码

命名空间

全部小写命名

宏命名

宏命名为全部大写,并且以下划线分割,如:

#define ROUND(x) .. 复制代码

不过不推荐在代码中使用宏。

枚举命名

与常量或宏一致,即kEnumNameENUM_NAME。个人更倾向于后者。


作者:程序员老梁
链接:https://juejin.cn/post/7019140493397196807


文章分类
后端
版权声明:本站是系统测试站点,无实际运营。本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 XXXXXXo@163.com 举报,一经查实,本站将立刻删除。
相关推荐