C++代码风格养成之路(一)

0. 为什么要写下来

学习C++和使用C++已经4年左右了,关于C++的知识书籍也都看了很多,但一直也没有形成自己的知识库,很多东西串联不起来。工作中也会看到很多别人写的代码,看起来就非常舒服,有一种欣赏艺术的感觉。自己也快到而立之年,也还想在技术这条路上走得更远些。因此决定从现在开始记录下的自己总结、笔记。本系列主要参考google C++ 代码规范,加上自己的理解后所选择的一个风格,仅供自己参考,会不断调整。
google代码规范地址为:中文版 、英文版

1. 命名约定

  • 文件名要全部小写,可以包含连字符 (-),C++ 文件要以.cc结尾, 头文件以 .h结尾,专门插入文本的文件则以.inc 结尾。

  • 普通变量一律小写, 单词之间用下划线连接。普通变量是指:函数定义内的局部变量、全局变量、源文件的文件作用域的静态变量,函数内定义静态变量、函数的参数。

  • 类的数据成员,不管是静态的还是非静态的, 类数据成员都可以和普通变量一样, 但是要在最后面接下划线。

  • 结构体变量不管是静态的还是非静态的, 结构体数据成员都可以和普通变量一样, 不用像类那样接下划线。

  • 常规函数使用大小写混合, 取值(get)和设值(set)函数则要求与变量名匹配(使用小写,用下划线链接)。

  • 常量和枚举值的命名以 “k” 开头, 大小写混合. 例如: const int kDaysInAWeek = 7;

  • 宏命名一定要全部大写字母,可以用下划线链接起来。

  • 对于表示类型的名称,包括类、结构体、类型定义(typedef)、枚举、模板参数全都使用相同约定, 即以大写字母开始, 每个单词首字母均大写, 不包含下划线。

  • 命名空间以小写字母命名. 最高级命名空间的名字取决于项目名称,不使用缩写作为名称 。

2. 注释

关于什么时候该有注释,由开发员自己去把控。注释的内容除了不应当详细描述怎么做的细节外,其它你认为重要的东西都可以卸载注释里面。具体怎么做的,应该由代码来体现。

所有注释都只使用行注释`//`这样一种形式!

由于个人有点轻微的强迫症,导致使用块注释时经常去纠结对齐的问题。大块的文件、类或者函数注释时,只要前面的`//`对齐好,注释内容适当的缩进,注释整体看起来也还是很舒服的,例如下面的代码:

// Iterates over the contents of a GargantuanTable.
// Example:
//    GargantuanTableIterator* iter = table->NewIterator();
//    for (iter->Seek("foo"); !iter->done(); iter->Next()) {
//      process(iter->key(), iter->value());
//    }
//    delete iter;
class GargantuanTableIterator {
  ...
};

3. 书写格式

我已经决定按照如下书写格式来写代码:

  • 需要缩进时只使用空格, 每次缩进 2 个空格,函数声明或者定义太长需要换行时,保持4个空格的缩进。
  • 每一行代码字符数不超过100。
  • 函数定义和if条件语句、循环语句后面的{直接跟在后面,而不是另起一行。
  • 函数声明和定义时,参数有多行时,后面行的第一个参数都与第一行的第一个参数对齐。
  • switch语句可以使用大括号分段, 以表明 cases 之间不是连在一起的。在单语句循环里, 括号可用可不用. 空循环体应使用 {}continue
switch (var) {
  case 0: {  // 2 空格缩进
    ...      // 4 空格缩进
    break;
  }  //用花括号分开case
  case 1: {
    ...
    break;
  }
  default: {
    assert(false);
  }
}
  • 单语句循环里或者单语句条件执行时,花语句也必须有。
for (int i = 0; i < kSomeNumber; ++i) {
  printf("I take it back\n");
}
  • 空循环或条件执行语句用continue或者{}替代。

你可能感兴趣的:(C++代码风格养成之路(一))