C++编码格式建议

每个人都可能有自己的代码风格和格式,但如果一个项目中的所有人都遵循同一风格的话,这个项目就能更顺利地进行。每个人未必能同意下述的每一处格式规则,而且其中的不少规则需要一定时间的适应,但整个项目服从统一的编程风格是很重要的,只有这样才能让所有人轻松地阅读和理解代码。

1.字符编码

尽量不要使用非ASCII字符,万不得已时才使用。源码文件请使用UTF8编码。现如今字符编码种类繁多,每一个国家和地区的本土化字符编码各不相同,为使代码在不同环境下能够正常显示,建议使用统一的UTF8编码。

2.缩进

缩进的宽度建议四个空格或一个Tab,使用Tab时请将编辑器的Tab宽度设置为4个空格。很多编辑器的Tab字符宽度默认为4个空格,如Notepad++、Sublime与Source Insight。

3.函数

3.1函数声明与定义

尽可能精简行数,函数返回类型和函数名在同一行,参数也尽量放在同一行,如果放不下就对形参分行且与第一个形参对齐,或者另起一行且缩进四格,分行方式与函数调用一致。函数看上去像这样:

//函数返回类型、函数名和参数放在同一行
ReturnType  ClassName::functionName(Type parName1, Type parName2) 
{
    doSomething();
    ...
}

//如果同一行文本太多,放不下所有参数
ReturnType  ClassName::functionName(Type parName1, Type parName2,
                                    Type parName3)
{
    doSomething();
    ...
}

//甚至连第一个参数都放不下
ReturnType  LongClassName::reallyReallyReallyReallyLongFunctionName(
Type parName1,Type parName2,Type parName3)      // 4 space indent 
{
doSomething();      // 4 space indent
    ...
}

3.2函数调用

函数调用格式与函数申明与定义格式基本相同,要么一行写完函数调用,要么在圆括号里对参数分行且与第一个参数对齐,要么参数另起一行且缩进四格。如果接收函数返回值,则函数返回值与函数名在同一行。书写形式如下:

bool retval = doSomething(argument1, argument2, argument3);

//参数分行
bool retval = DoSomething(averyveryveryverylongargument1,
                      argument2, argument3);

//参数另起一行
bool retval = veryVeryVeryVeryVeryVeryVeryVeryVeryLongFunctionName(
argument1,argument2,argument3, argument4);

把多个参数放在同一行以减少函数调用所需的行数,除非影响到可读性。有人认为把每个参数都独立成行,不仅更好读,而且方便编辑参数。不过,比起所谓的参数编辑,我们更看重可读性。如果某参数独立成行, 对可读性更有帮助的话,那也可以如此做。参数的格式处理应当以可读性而非其他作为最重要的原则。此外, 如果一系列参数本身就有一定的结构, 可以酌情地按其结构来决定参数格式:

// 通过 3x3 矩阵转换 widget.
myWidget.transform(x1, x2, x3,
                   y1, y2, y3,
                   z1, z2, z3);

如果一些参数本身就是略复杂的表达式,且降低了可读性,那么可以直接创建临时变量描述该表达式,并传递给函数:

int my_heuristic = scores[x] * y + bases[x];
bool retval = doSomething(my_heuristic, x, y, z);

4.Lambda表达式

Lambda 表达式对形参和函数体的格式化和其他函数一致。捕获列表同理,表项用逗号隔开。短 Lambda 就写得和内联函数一样。

std::set<int> blacklist = {7, 8, 9};
std::vector<int> digits = {3, 9, 1, 8, 4, 7, 1};
digits.erase(std::remove_if(digits.begin(), digits.end(), [&blacklist](int i){
    return blacklist.find(i) != blacklist.end();
}),digits.end());

5.列表初始化

列表初始化书写格式建议与函数调用格式一致。如果列表初始化伴随着名字,比如类型或变量名,格式化时将将名字视作函数调用名,{}视作函数调用的小括号。如果没有名字,就视作名字长度为零。举例如下:

//一行列表初始化
return {foo, bar};
functionCall({foo, bar});
pair<int, int> p{foo, bar};

//断行列表初始化
MyType m = { superlongvariablename1,uperlongvariablename2,
           {short, interior, list},
           {interiorwrappinglist,interiorwrappinglist2}};

6.条件语句

(1)小括号内不使用空格 关键字 if 和 else 另起一行。对基本条件语句有两种可以接受的格式,一种在圆括号和条件之间有空格,另一种没有,倾向于不在圆括号内使用空格。如果你是在修改一个文件,参考当前已有格式,如果是写新的代码,参考目录下或项目中其它文件。

if (condition)   //圆括号里没有空格
{
...         // 4空格缩进.
} 
else if (...)   // else 与 if 的右括号同一行
{
  ...
} 
else
{
  ...
}

(2)单条语句独立成行且使用大括号 通常,单行语句建议使用大括号,为了避免将来在单行语句之后新增添加代码而忘记添加大括号。复杂的条件或循环语句用大括号可读性会更好。

//不建议使用
if (condition) DoSomething();

//建议使用
if (condition)
{
    DoSomething();  // 4空格缩进
}

(3)简短单条语句写在同一行且不用大括号 如果能增强可读性,简短的条件语句允许写在同一行且不用添加大括号,只有当语句简单并且没有使用else 子句时使用。

if (x == kFoo) return new Foo();
if (x == kBar) return new Bar();

(4)大括号、if、else、else if独立成行 为了保证代码结构的易读清晰,不要吝惜代码篇幅,建议将大括号、if、else、else if独立成行。

//代码过于近密集,不清晰
if (condition) {
foo;
} else if(...){
bar;
}else{
fooBar;
}

//结构清晰明了易读
if (condition)
{
    foo;
} 
else if(...)
{
    bar;
}
else
{
    fooBar;
}

7.循环和开关选择语句

在单语句循环里,大括号建议使用:

//不建议
for (int i = 0; i < kSomeNumber; ++i)
     printf("I love you\n");


//建议
for (int i = 0; i < kSomeNumber; ++i) 
{
    printf("I take it back\n");
}

空循环体应使用 {} 或 continue,而不是一个简单的分号。

while (condition)
{
    //反复循环直到条件失效.
}
for (int i = 0; i < kSomeNumber; ++i) {}    //空循环体.
while (condition) continue;                 //contunue 表明没有逻辑.
while (condition);                          // 差,看起来仅仅只是 while/loop 的部分之一.

switch 语句中的 case 块不建议使用大括号。如果有不满足 case 条件的枚举值,switch 应该总是包含一个 default 匹配。如果 default永远执行不到,简单的加条 assert。

switch (var) 
{
    case 0:         // 4 空格缩进
        ...         // 8 空格缩进
        break;
    case 1: 
        ...
        break;
    default: 
        assert(false);
}

8指针和引用表达式

句点或箭头前后不要有空格,指针/地址操作符 (*, &) 之后不能有空格。正确使用范例:

x = *p;
p = &x;
x = r.y;
x = r->y;

在声明指针变量或参数时, 星号与类型或变量名紧挨都可以:

//好, 空格前置.
char *c;
const string &str;

//好, 空格后置.
char* c;
const string& str;

在单个文件内要保持风格一致, 所以, 如果是修改现有文件, 要遵照该文件的风格。

9.布尔表达式

如果一个布尔表达式超过标准行宽,断行方式要统一一下,逻辑运算符总是位于行首。

if (this_one_thing > this_other_thing
    &&a_third_thing == a_fourth_thing //与上一行的条件对齐
    &&yet_another && last_one)        //与上一行的条件对齐
{
    ...
}

10. 函数返回值

不要在 return 表达式里加上非必须的圆括号。只有在写 x = expr 要加上括号的时候才在 return expr; 里使用括号。

return result;                  // 返回值很简单, 没有圆括号.
// 可以用圆括号把复杂表达式圈起来, 改善可读性.
return (some_long_condition &&another_condition);
return (value);                // 毕竟您从来不会写 var = (value);
return(result);                // return 可不是函数!

11.变量及数组初始化

用 =, () 和 {} 均可,建议统一使用大括号形式的列表初始化。

int x = 3;
int x(3);
int x{3};                   //列表初始化
string name("Some Name");
string name = "Some Name";
string name{"Some Name"};   //列表初始化

请务必小心列表初始化 {…} 用std::initializer_list构造函数初始化出的类型,非空列表初始化就会优先调用std::initializer_list,不过空列表初始化除外,后者原则上会调用默认构造函数。如果向想强制禁用 std::initializer_list构造函数,请改用括号。

vector<int> v(100, 1);  // 内容为 100 个 1 的向量.
vector<int> v{100, 1};  // 内容为 100 和 1 的向量.

此外, 列表初始化不允许整型类型的四舍五入, 这可以用来避免一些类型上的编程失误.

int pi(3.14);  // 好 - pi == 3.
int pi{3.14};  // 编译错误: 缩窄转换.

12.预处理指令

预处理指令不要缩进,从行首开始。即使预处理指令位于缩进代码块中, 指令也应从行首开始。

// 好 - 指令从行首开始
     if (lopsided_score) 
{
#if DISASTER_PENDING      // 正确 - 从行首开始
        DropEverything();
# if NOTIFY                 // 非必要 - #后跟空格
        NotifyClient();
# endif
#endif
        BackToNormal();
}

// 差 - 指令缩进
if (lopsided_score) 
{
    #if DISASTER_PENDING    // 差 - "#if" 应该放在行开头
        DropEverything();
    #endif                  // 差 - "#endif" 不要缩进
        BackToNormal();
}

13.类格式

访问控制块的声明依次序是public:, protected:, private:,无需缩进。类声明的基本格式如下。

class MyClass : public OtherClass 
{
public:             // 无需缩进
MyClass();          // 标准的4空格缩进
    explicit MyClass(int var);
    ~MyClass() {}

    void SomeFunction();
    void SomeFunctionThatDoesNothing() {}

    void set_some_var(int var) {some_var_ = var;}
    int some_var() const {return some_var_;}

private:
    bool SomeInternalFunction();

    int some_var_;
    int some_other_var_;
};

注意事项: (1)除第一个关键词(一般是 public)外,其他关键词前要空一行,如果类比较小的话也可以不空; (2)public、protected和private这些关键词后不要保留空行; (3)public 放在最前面,然后是 protected,最后是 private。

14.构造函数初始值列表

构造函数初始化列表放在同一行或按四格缩进并排多行。下面两种初始值列表方式都可以接受:

// 如果所有变量能放在同一行:
MyClass::MyClass(int var) : some_var_(var)
{
    doSomething();
}

// 如果不能放在同一行,必须置于冒号后, 并缩进 4 个空格
MyClass::MyClass(int var)
: some_var_(var), some_other_var_(var + 1)
 {
    DoSomething();
}

// 如果初始化列表需要置于多行, 将每一个成员放在单独的一行,并逐行对齐
MyClass::MyClass(int var)
    : some_var_(var),               // 4 space indent
     some_other_var_(var + 1)       // lined up
{   
DoSomething();
}

// 右大括号 } 可以和左大括号 { 放在同一行,如果这样做合适的话
MyClass::MyClass(int var)
: some_var_(var) {}

15.命名空间格式化

(1)命名空间内容不缩进,不要增加额外的缩进层次。例如:

namespace
{
void foo() {  // 正确. 命名空间内没有额外的缩进.
...
}

}  // namespace

namespace 
{
    // 错, 缩进多余了.
    void foo() 
    {
        ...
    }
}  // namespace

(2)声明嵌套命名空间时, 每个命名空间都独立成行。

namespace foo 
{
...
namespace bar 
{
...
}
}

16.水平留白

水平留白的使用根据在代码中的位置决定,永远不要在行尾添加没意义的留白,坚持一个总领性原则:能不留别就不要添加多余的空白。

void f(bool b) 
{
    ...
    int i = 0;          // 分号前不加空格.
    int x[] = { 0 };    // 不建议,列表初始化中大括号内的空格多余
    int x[] = {0};      // 正确
}

// 继承与初始化列表中的冒号前后恒有空格
class Foo : public Bar 
{
public:
    // 对于单行函数的实现,在大括号内不要加上空格
    void Reset() {baz_ = 0;}
    ...
}

添加冗余的留白会给其他人编辑时造成额外负担,因此,行尾不要留空格。如果确定一行代码已经修改完毕,将多余的空格去掉,或者在专门清理空格时去掉。

17.垂直留白

垂直留白越少越好,这不仅仅是规则而是原则问题了,不在万不得已,不要使用空行,尤其是两个函数定义之间的空行不要超过2行,函数体首尾不要留空行, 函数体中也不要随意添加空行。

基本原则是:同一屏可以显示的代码越多,越容易理解程序的控制流,当然,过于密集的代码块和过于疏松的代码块同样难看,这取决于你的判断,但通常是垂直留白越少越好。

下面的规则可以让加入的空行更有效: (1)函数体内开头或结尾的空行可读性微乎其微; (2)在多重 if-else 块里加空行或许有点可读性。

参考文献

[1]Google C++编程风格指南

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Coding+

JS 中的一些概念问题

在 JS 中,每个对象都会在内部引用一个叫做prototype的对象,而这个原型对象本身也会引用自己的原型对象,并以此类推。这样就形成了一条原型引用链,这个链的...

10930
来自专栏mathor

第五届蓝桥杯决赛B组C/C++——Log大侠

15660
来自专栏HTML5学堂

2015.12.07 HTML5真题练习

HTML5学堂:每天一道题,强壮程序员!今日主要涉及12.04题目(数据类型、NaN)的解答,以及一道涉及作用域、this指向相关知识的题目。 HTML5真题【...

33580
来自专栏北京马哥教育

PEP8 Python 编码规范整理

作者:willhuo 来源:http://lib.csdn.net/article/python/1534 决定开始Python之路了,利用业余时间,争取更深入...

37660
来自专栏IT探索

shell用法(包括awk sed grep eval expr等)

1:取出文件中的第i行到第j行:awk 'NR>=i && NR<=j {print $0}' filename

10110
来自专栏C++

python笔记:#011#循环

21120
来自专栏linjinhe的专栏

Go语言:map使用笔记

Go 的 map 是 hash map; C++ 的 map 是 tree (主流实现是红黑树); C++ 的 hash map 是unordered_ma...

58050
来自专栏转载gongluck的CSDN博客

结构体字节对齐

      在用sizeof运算符求算某结构体所占空间时,并不是简单地将结构体中所有元素各自占的空间相加,这里涉及到内存字节对齐的问题。从理论上讲,对于任何变量...

41150
来自专栏WindCoder

《简明 Python 教程》学习笔记- 基本概念

最近除了忙着论坛那边,就是忙着攻克Python,都好久没来更新了。今天暂且发出一小部分之前自学时做的笔记吧。假期忽然对脚本语言产生了兴趣,最终选择了这个先学着(...

8010
来自专栏章鱼的慢慢技术路

用Go语言实现一个简单的聊天机器人

Go语言基本构成要素:标识符、关键字、字面量、分隔符、操作符。它们可以组成各种表达式和语句,而后者都无需以分号结尾。

14120

扫码关注云+社区

领取腾讯云代金券