时间:2021-4-14
内容:
1.Leetcode每日一题,今天学习了前缀树
2.完成线程池的框架初稿了,接下来是性能测试
卢玮
@lwdreamofly
lwdreamofly 发布的帖子
-
RE: Google C++ style学习笔记
格式(TODO)
行长度
- 每一行代码字符数不超过 80.
- 如果无法在不伤害易读性的条件下进行断行, 那么注释行可以超过 80 个字符, 这样可以方便复制粘贴. 例如, 带有命令示例或 URL 的行可以超过 80 个字符.
非ASCII字符
- 尽量不使用非 ASCII 字符, 使用时必须使用 UTF-8 编码.
空格还是制表位
- 只使用空格, 每次缩进 2 个空格.
函数声明与定义
- 返回类型和函数名在同一行, 参数也尽量放在同一行, 如果放不下就对形参分行.
函数看上去像这样:
ReturnType ClassName::FunctionName(Type par_name1, Type par_name2) { DoSomething(); ... }
如果同一行文本太多, 放不下所有参数:
ReturnType ClassName::ReallyLongFunctionName(Type par_name1, Type par_name2, Type par_name3) { DoSomething(); ... }
甚至连第一个参数都放不下:
ReturnType LongClassName::ReallyReallyReallyLongFunctionName( Type par_name1, // 4 space indent Type par_name2, Type par_name3) { DoSomething(); // 2 space indent ... }
注意以下几点:
- 使用好的参数名.
- 只有在参数未被使用或者其用途非常明显时, 才能省略参数名.
- 如果返回类型和函数名在一行放不下, 分行.
- 如果返回类型与函数声明或定义分行了, 不要缩进.
- 左圆括号总是和函数名在同一行.
- 函数名和左圆括号间永远没有空格.
- 圆括号与参数间没有空格.
- 左大括号总在最后一个参数同一行的末尾处, 不另起新行.
- 右大括号总是单独位于函数最后一行, 或者与左大括号同一行.
- 右圆括号和左大括号间总是有一个空格.
- 所有形参应尽可能对齐.
- 缺省缩进为 2 个空格.
- 换行后的参数保持 4 个空格的缩进.
未被使用的参数, 或者根据上下文很容易看出其用途的参数, 可以省略参数名:
class Foo { public: Foo(Foo&&); Foo(const Foo&); Foo& operator=(Foo&&); Foo& operator=(const Foo&); };
未被使用的参数如果其用途不明显的话, 在函数定义处将参数名注释起来:
class Shape { public: virtual void Rotate(double radians) = 0; }; class Circle : public Shape { public: void Rotate(double radians) override; }; void Circle::Rotate(double /*radians*/) {} // 差 - 如果将来有人要实现, 很难猜出变量的作用. void Circle::Rotate(double) {}
属性, 和展开为属性的宏, 写在函数声明或定义的最前面, 即返回类型之前:
MUST_USE_RESULT bool IsOK();
Lambda 表达式(TODO)
TODO
函数调用
- 要么一行写完函数调用, 要么在圆括号里对参数分行, 要么参数另起一行且缩进四格. 如果没有其它顾虑的话, 尽可能精简行数, 比如把多个参数适当地放在同一行里
列表初始化格式(TODO)
TODO
条件语句
最常见的是没有空格的格式. 哪一种都可以, 最重要的是 保持一致. 如果你是在修改一个文件, 参考当前已有格式. 如果是写新的代码, 参考目录下或项目中其它文件. 还在犹豫的话, 就不要加空格了.
if (condition) { // 圆括号里没有空格. ... // 2 空格缩进. } else if (...) { // else 与 if 的右括号同一行. ... } else { ... }
注意所有情况下
if
和左圆括号间都有个空格. 右圆括号和左大括号之间也要有个空格:if(condition) // 差 - IF 后面没空格. if (condition){ // 差 - { 前面没空格. if(condition){ // 变本加厉地差. if (condition) { // 好 - IF 和 { 都与空格紧邻.
如果能增强可读性, 简短的条件语句允许写在同一行. 只有当语句简单并且没有使用
else
子句时使用:if (x == kFoo) return new Foo(); if (x == kBar) return new Bar();
如果语句有
else
分支则不允许:// 不允许 - 当有 ELSE 分支时 IF 块却写在同一行 if (x) DoThis(); else DoThat();
通常, 单行语句不需要使用大括号, 如果你喜欢用也没问题; 复杂的条件或循环语句用大括号可读性会更好. 也有一些项目要求
if
必须总是使用大括号:if (condition) DoSomething(); // 2 空格缩进. if (condition) { DoSomething(); // 2 空格缩进. }
但如果语句中某个
if-else
分支使用了大括号的话, 其它分支也必须使用:// 不可以这样子 - IF 有大括号 ELSE 却没有. if (condition) { foo; } else bar; // 不可以这样子 - ELSE 有大括号 IF 却没有. if (condition) foo; else { bar; } // 只要其中一个分支用了大括号, 两个分支都要用上大括号. if (condition) { foo; } else { bar; }
循环和开关语句
switch
语句中的case
块可以使用大括号也可以不用, 取决于你的个人喜好. 如果用的话, 要按照下文所述的方法.如果有不满足
case
条件的枚举值,switch
应该总是包含一个default
匹配 (如果有输入值没有 case 去处理, 编译器将给出 warning). 如果default
应该永远执行不到, 简单的加条assert
:switch (var) { case 0: { // 2 空格缩进 ... // 4 空格缩进 break; } case 1: { ... break; } default: { assert(false); } }
在单语句循环里, 括号可用可不用:
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 的部分之一.
指针或引用表达式
- 句点或箭头前后不要有空格. 指针/地址操作符 (
*, &
) 之后不能有空格.
下面是指针和引用表达式的正确使用范例:
x = *p; p = &x; x = r.y; x = r->y;
注意:
- 在访问成员时, 句点或箭头前后没有空格.
- 指针操作符
*
或&
后没有空格.
在声明指针变量或参数时, 星号与类型或变量名紧挨都可以:
// 好, 空格前置. char *c; const string &str; // 好, 空格后置. char* c; const string& str; int x, *y; // 不允许 - 在多重声明中不能使用 & 或 * char * c; // 差 - * 两边都有空格 const string & str; // 差 - & 两边都有空格.
在单个文件内要保持风格一致, 所以, 如果是修改现有文件, 要遵照该文件的风格.
布尔表达式
- 如果一个布尔表达式超过 标准行宽, 断行方式要统一一下
- 逻辑操作符总位于行尾
- 直接用符号形式的操作符, 比如
&&
和~
, 不要用词语形式的and
和compl
函数返回值
- 不要在
return
表达式里加上非必须的圆括号
只有在写
x = expr
要加上括号的时候才在return expr;
里使用括号.return result; // 返回值很简单, 没有圆括号. // 可以用圆括号把复杂表达式圈起来, 改善可读性. return (some_long_condition && another_condition);
return (value); // 毕竟您从来不会写 var = (value); return(result); // return 可不是函数!
变量及数组初始化(TODO)
- 用
=
,()
和{}
均可.
您可以用
=
,()
和{}
, 以下的例子都是正确的:int x = 3; int x(3); int x{3}; string name("Some Name"); string name = "Some Name"; string name{"Some Name"};
预处理指令
- 预处理指令不要缩进, 从行首开始.
类格式
- 访问控制块的声明依次序是
public:
,protected:
,private:
, 每个都缩进 1 个空格.
类声明的基本格式如下:
class MyClass : public OtherClass { public: // 注意有一个空格的缩进 MyClass(); // 标准的两空格缩进 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_; };
注意事项:
- 所有基类名应在 80 列限制下尽量与子类名放在同一行.
- 关键词
public:
,protected:
,private:
要缩进 1 个空格. - 除第一个关键词 (一般是
public
) 外, 其他关键词前要空一行. 如果类比较小的话也可以不空. - 这些关键词后不要保留空行.
public
放在最前面, 然后是protected
, 最后是private
.
构造函数初始化列表(TODO)
TODO
命名空间格式化(TODO)
TODO
水平留白
通用
void f(bool b) { // 左大括号前总是有空格. ... int i = 0; // 分号前不加空格. // 列表初始化中大括号内的空格是可选的. // 如果加了空格, 那么两边都要加上. int x[] = { 0 }; int x[] = {0}; // 继承与初始化列表中的冒号前后恒有空格. class Foo : public Bar { public: // 对于单行函数的实现, 在大括号内加上空格 // 然后是函数实现 Foo(int b) : Bar(), baz_(b) {} // 大括号里面是空的话, 不加空格. void Reset() { baz_ = 0; } // 用空格把大括号与实现分开. ...
添加冗余的留白会给其他人编辑时造成额外负担. 因此, 行尾不要留空格. 如果确定一行代码已经修改完毕, 将多余的空格去掉; 或者在专门清理空格时去掉(尤其是在没有其他人在处理这件事的时候).
循环和条件语句
if (b) { // if 条件语句和循环语句关键字后均有空格. } else { // else 前后有空格. } while (test) {} // 圆括号内部不紧邻空格. switch (i) { for (int i = 0; i < 5; ++i) { switch ( i ) { // 循环和条件语句的圆括号里可以与空格紧邻. if ( test ) { // 圆括号, 但这很少见. 总之要一致. for ( int i = 0; i < 5; ++i ) { for ( ; i < 5 ; ++i) { // 循环里内 ; 后恒有空格, ; 前可以加个空格. switch (i) { case 1: // switch case 的冒号前无空格. ... case 2: break; // 如果冒号有代码, 加个空格.
操作符
// 赋值运算符前后总是有空格. x = 0; // 其它二元操作符也前后恒有空格, 不过对于表达式的子式可以不加空格. // 圆括号内部没有紧邻空格. v = w * x + y / z; v = w*x + y/z; v = w * (x + z); // 在参数和一元操作符之间不加空格. x = -5; ++x; if (x && !y) ...
模板和转换
// 尖括号(< and >) 不与空格紧邻, < 前没有空格, > 和 ( 之间也没有. vector<string> x; y = static_cast<char*>(x); // 在类型与指针操作符之间留空格也可以, 但要保持一致. vector<char *> x;
垂直留白
- 垂直留白越少越好.
这不仅仅是规则而是原则问题了: 不在万不得已, 不要使用空行. 尤其是: 两个函数定义之间的空行不要超过 2 行, 函数体首尾不要留空行, 函数体中也不要随意添加空行.
基本原则是: 同一屏可以显示的代码越多, 越容易理解程序的控制流. 当然, 过于密集的代码块和过于疏松的代码块同样难看, 这取决于你的判断. 但通常是垂直留白越少越好.
下面的规则可以让加入的空行更有效:
- 函数体内开头或结尾的空行可读性微乎其微.
- 在多重 if-else 块里加空行或许有点可读性.
-
RE: Google C++ style学习笔记
注释
- 对于 Chinese coders 来说, 用英文注释还是用中文注释, it is a problem, 但不管怎样, 注释是为了让别人看懂, 难道是为了炫耀编程语言之外的你的母语或外语水平吗
注释风格
- 使用
//
或/* */
, 统一就好.
文件注释
- 在每一个文件开头加入版权公告.
- 文件注释描述了该文件的内容. 如果一个文件只声明, 或实现, 或测试了一个对象, 并且这个对象已经在它的声明处进行了详细的注释, 那么就没必要再加上文件注释. 除此之外的其他文件都需要文件注释.
类注释
-
每个类的定义都要附带一份注释, 描述类的功能和用法, 除非它的功能相当明显.
// 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 { ... };
-
如果类的声明和定义分开了(例如分别放在了
.h
和.cc
文件中), 此时, 描述类用法的注释应当和接口定义放在一起, 描述类的操作和实现的注释应当和实现放在一起.
函数注释
- 函数声明处的注释描述函数功能; 定义处的注释描述函数实现.
函数声明
基本上每个函数声明处前都应当加上注释, 描述函数的功能和用途. 只有在函数的功能简单而明显时才能省略这些注释(例如, 简单的取值和设值函数). 注释使用叙述式 (“Opens the file”) 而非指令式 (“Open the file”); 注释只是为了描述函数, 而不是命令函数做什么. 通常, 注释不会描述函数如何工作. 那是函数定义部分的事情.
函数声明处注释的内容:
- 函数的输入输出.
- 对类成员函数而言: 函数调用期间对象是否需要保持引用参数, 是否会释放这些参数.
- 函数是否分配了必须由调用者释放的空间.
- 参数是否可以为空指针.
- 是否存在函数使用上的性能隐患.
- 如果函数是可重入的, 其同步前提是什么?
举例如下:
// Returns an iterator for this table. It is the client's // responsibility to delete the iterator when it is done with it, // and it must not use the iterator once the GargantuanTable object // on which the iterator was created has been deleted. // // The iterator is initially positioned at the beginning of the table. // // This method is equivalent to: // Iterator* iter = table->NewIterator(); // iter->Seek(""); // return iter; // If you are going to immediately seek to another place in the // returned iterator, it will be faster to use NewIterator() // and avoid the extra seek. Iterator* GetIterator() const;
但也要避免罗罗嗦嗦, 或者对显而易见的内容进行说明. 下面的注释就没有必要加上 “否则返回 false”, 因为已经暗含其中了:
// Returns true if the table cannot hold any more entries. bool IsTableFull();
注释函数重载时, 注释的重点应该是函数中被重载的部分, 而不是简单的重复被重载的函数的注释. 多数情况下, 函数重载不需要额外的文档, 因此也没有必要加上注释.
注释构造/析构函数时, 切记读代码的人知道构造/析构函数的功能, 所以 “销毁这一对象” 这样的注释是没有意义的. 你应当注明的是注明构造函数对参数做了什么 (例如, 是否取得指针所有权) 以及析构函数清理了什么. 如果都是些无关紧要的内容, 直接省掉注释. 析构函数前没有注释是很正常的.
函数定义
如果函数的实现过程中用到了很巧妙的方式, 那么在函数定义处应当加上解释性的注释. 例如, 你所使用的编程技巧, 实现的大致步骤, 或解释如此实现的理由. 举个例子, 你可以说明为什么函数的前半部分要加锁而后半部分不需要.
不要 从
.h
文件或其他地方的函数声明处直接复制注释. 简要重述函数功能是可以的, 但注释重点要放在如何实现上.变量注释
- 通常变量名本身足以很好说明变量用途. 某些情况下, 也需要额外的注释说明.
类数据成员
每个类数据成员 (也叫实例变量或成员变量) 都应该用注释说明用途. 如果有非变量的参数(例如特殊值, 数据成员之间的关系, 生命周期等)不能够用类型与变量名明确表达, 则应当加上注释. 然而, 如果变量类型与变量名已经足以描述一个变量, 那么就不再需要加上注释.
特别地, 如果变量可以接受
NULL
或-1
等警戒值, 须加以说明. 比如:private: // Used to bounds-check table accesses. -1 means // that we don't yet know how many entries the table has. int num_total_entries_;
全局变量
和数据成员一样, 所有全局变量也要注释说明含义及用途, 以及作为全局变量的原因. 比如:
// The total number of tests cases that we run through in this regression test. const int kNumTestCases = 6;
实现注释
- 对于代码中巧妙的, 晦涩的, 有趣的, 重要的地方加以注释.
代码前注释
巧妙或复杂的代码段前要加注释. 比如:
// Divide result by two, taking into account that x // contains the carry from the add. for (int i = 0; i < result->size(); i++) { x = (x << 8) + (*result)[i]; (*result)[i] = x >> 1; x &= 1; }
行注释
比较隐晦的地方要在行尾加入注释. 在行尾空两格进行注释. 比如:
// If we have enough memory, mmap the data portion too. mmap_budget = max<int64>(0, mmap_budget - index_->length()); if (mmap_budget >= data_size_ && !MmapData(mmap_chunk_bytes, mlock)) return; // Error already logged.
注意, 这里用了两段注释分别描述这段代码的作用, 和提示函数返回时错误已经被记入日志.
如果你需要连续进行多行注释, 可以使之对齐获得更好的可读性:
DoSomething(); // Comment here so the comments line up. DoSomethingElseThatIsLonger(); // Two spaces between the code and the comment. { // One space before comment when opening a new scope is allowed, // thus the comment lines up with the following comments and code. DoSomethingElse(); // Two spaces before line comments normally. } std::vector<string> list{ // Comments in braced lists describe the next element... "First item", // .. and should be aligned appropriately. "Second item"}; DoSomething(); /* For trailing block comments, one space is fine. */
函数参数注释
如果函数参数的意义不明显, 考虑用下面的方式进行弥补:
- 如果参数是一个字面常量, 并且这一常量在多处函数调用中被使用, 用以推断它们一致, 你应当用一个常量名让这一约定变得更明显, 并且保证这一约定不会被打破.
- 考虑更改函数的签名, 让某个
bool
类型的参数变为enum
类型, 这样可以让这个参数的值表达其意义. - 如果某个函数有多个配置选项, 你可以考虑定义一个类或结构体以保存所有的选项, 并传入类或结构体的实例. 这样的方法有许多优点, 例如这样的选项可以在调用处用变量名引用, 这样就能清晰地表明其意义. 同时也减少了函数参数的数量, 使得函数调用更易读也易写. 除此之外, 以这样的方式, 如果你使用其他的选项, 就无需对调用点进行更改.
- 用具名变量代替大段而复杂的嵌套表达式.
- 万不得已时, 才考虑在调用点用注释阐明参数的意义.
比如下面的示例的对比:
// What are these arguments? const DecimalNumber product = CalculateProduct(values, 7, false, nullptr);
和
ProductOptions options; options.set_precision_decimals(7); options.set_use_cache(ProductOptions::kDontUseCache); const DecimalNumber product = CalculateProduct(values, options, /*completion_callback=*/nullptr);
哪个更清晰一目了然.
不允许的行为
不要描述显而易见的现象, 永远不要 用自然语言翻译代码作为注释, 除非即使对深入理解 C++ 的读者来说代码的行为都是不明显的. 要假设读代码的人 C++ 水平比你高, 即便他/她可能不知道你的用意:
你所提供的注释应当解释代码 为什么 要这么做和代码的目的, 或者最好是让代码自文档化.
比较这样的注释:
// Find the element in the vector. <-- 差: 这太明显了! auto iter = std::find(v.begin(), v.end(), element); if (iter != v.end()) { Process(element); }
和这样的注释:
// Process "element" unless it was already processed. auto iter = std::find(v.begin(), v.end(), element); if (iter != v.end()) { Process(element); }
自文档化的代码根本就不需要注释. 上面例子中的注释对下面的代码来说就是毫无必要的:
if (!IsAlreadyProcessed(element)) { Process(element); }
TODO
注释对那些临时的, 短期的解决方案, 或已经够好但仍不完美的代码使用
TODO
注释.TODO
注释要使用全大写的字符串TODO
, 在随后的圆括号里写上你的名字, 邮件地址, bug ID, 或其它身份标识和与这一TODO
相关的 issue. 主要目的是让添加注释的人 (也是可以请求提供更多细节的人) 可根据规范的TODO
格式进行查找. 添加TODO
注释并不意味着你要自己来修正, 因此当你加上带有姓名的TODO
时, 一般都是写上自己的名字.// TODO(kl@gmail.com): Use a "*" here for concatenation operator. // TODO(Zeke) change this to use relations. // TODO(bug 12345): remove the "Last visitors" feature
如果加
TODO
是为了在 “将来某一天做某事”, 可以附上一个非常明确的时间 “Fix by November 2005”), 或者一个明确的事项 (“Remove this code when all clients can handle XML responses.”).弃用注释
通过弃用注释(
DEPRECATED
comments)以标记某接口点已弃用.您可以写上包含全大写的
DEPRECATED
的注释, 以标记某接口为弃用状态. 注释可以放在接口声明前, 或者同一行.在
DEPRECATED
一词后, 在括号中留下您的名字, 邮箱地址以及其他身份标识.弃用注释应当包涵简短而清晰的指引, 以帮助其他人修复其调用点. 在 C++ 中, 你可以将一个弃用函数改造成一个内联函数, 这一函数将调用新的接口.
仅仅标记接口为
DEPRECATED
并不会让大家不约而同地弃用, 您还得亲自主动修正调用点(callsites), 或是找个帮手.修正好的代码应该不会再涉及弃用接口点了, 着实改用新接口点. 如果您不知从何下手, 可以找标记弃用注释的当事人一起商量.
-
RE: Google C++ style学习笔记
命名约定(TODO)
通用命名规则
- 函数命名, 变量命名, 文件命名要有描述性; 少用缩写.
尽可能使用描述性的命名, 别心疼空间, 毕竟相比之下让代码易于新读者理解更重要. 不要用只有项目开发者能理解的缩写, 也不要通过砍掉几个字母来缩写单词.
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; // 删减了若干字母.
注意, 一些特定的广为人知的缩写是允许的, 例如用
i
表示迭代变量和用T
表示模板参数.文件命名
- 文件名要全部小写, 可以包含下划线 (
_
) 或连字符 (-
), 依照项目的约定. 如果没有约定, 那么 “_
” 更好.
可接受的文件命名示例:
my_useful_class.cc
my-useful-class.cc
myusefulclass.cc
myusefulclass_test.cc
//_unittest
和_regtest
已弃用.
C++ 文件要以
.cc
结尾, 头文件以.h
结尾.不要使用已经存在于
/usr/include
下的文件名, 如db.h
.通常应尽量让文件名更加明确.
http_server_logs.h
就比logs.h
要好. 定义类时文件名一般成对出现, 如foo_bar.h
和foo_bar.cc
, 对应于类FooBar
.内联函数必须放在
.h
文件中. 如果内联函数比较短, 就直接放在.h
中.类型命名
- 类型名称的每个单词首字母均大写, 不包含下划线:
MyExcitingClass
,MyExcitingEnum
.
所有类型命名 —— 类, 结构体, 类型定义 (
typedef
), 枚举, 类型模板参数 —— 均使用相同约定, 即以大写字母开始, 每个单词首字母均大写, 不包含下划线. 例如:// 类和结构体 class UrlTable { ... class UrlTableTester { ... struct UrlTableProperties { ... // 类型定义 typedef hash_map<UrlTableProperties *, string> PropertiesMap; // using 别名 using PropertiesMap = hash_map<UrlTableProperties *, string>; // 枚举 enum UrlTableErrors { ...
变量命名
- 变量 (包括函数参数) 和数据成员名一律小写, 单词之间用下划线连接. 类的成员变量以下划线结尾, 但结构体的就不用, 如:
a_local_variable
,a_struct_data_member
,a_class_data_member_
.
普通变量命名
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; };
常量命名
声明为
constexpr
或const
的变量, 或在程序运行期间其值始终保持不变的, 命名时以 “k” 开头, 大小写混合. 例如:const int kDaysInAWeek = 7;
函数命名
- 常规函数使用大小写混合, 取值和设值函数则要求与变量名匹配:
MyExcitingFunction()
,MyExcitingMethod()
,my_exciting_member_variable()
,set_my_exciting_member_variable()
.
一般来说, 函数名的每个单词首字母大写 (即 “驼峰变量名” 或 “帕斯卡变量名”), 没有下划线. 对于首字母缩写的单词, 更倾向于将它们视作一个单词进行首字母大写 (例如, 写作
StartRpc()
而非StartRPC()
).AddTableEntry() DeleteUrl() OpenFileOrDie()
(同样的命名规则同时适用于类作用域与命名空间作用域的常量, 因为它们是作为 API 的一部分暴露对外的, 因此应当让它们看起来像是一个函数, 因为在这时, 它们实际上是一个对象而非函数的这一事实对外不过是一个无关紧要的实现细节.)
取值和设值函数的命名与变量一致. 一般来说它们的名称与实际的成员变量对应, 但并不强制要求. 例如
int count()
与void set_count(int count)
.命名空间命名(TODO)
TODO
枚举命名
- 枚举的命名应当和 常量 或 宏 一致:
kEnumName
或是ENUM_NAME
.(优先采用常量变量名)
宏命名
你并不打算使用宏, 对吧? 如果你一定要用, 像这样命名:
MY_MACRO_THAT_SCARES_SMALL_CHILDREN
.命名规则的特例(TODO)
TODO
-
RE: Google C++ style学习笔记
其他C++特性(TODO)
预处理宏
- 使用宏时要非常谨慎, 尽量以内联函数, 枚举和常量代替之.
下面给出的用法模式可以避免使用宏带来的问题; 如果你要宏, 尽可能遵守:
- 不要在
.h
文件中定义宏. - 在马上要使用时才进行
#define
, 使用后要立即#undef
. - 不要只是对已经存在的宏使用#undef,选择一个不会冲突的名称;
- 不要试图使用展开后会导致 C++ 构造不稳定的宏, 不然也至少要附上文档说明其行为.
- 不要用
##
处理函数,类和变量的名字。
-
RE: Google C++ style学习笔记
函数(TODO)
编写简短函数
我们承认长函数有时是合理的, 因此并不硬性限制函数的长度. 如果函数超过 40 行, 可以思索一下能不能在不影响程序结构的前提下对其进行分割.
即使一个长函数现在工作的非常好, 一旦有人对其修改, 有可能出现新的问题, 甚至导致难以发现的 bug. 使函数尽量简短, 以便于他人阅读和修改代码.
在处理代码时, 你可能会发现复杂的长函数. 不要害怕修改现有代码: 如果证实这些代码使用 / 调试起来很困难, 或者你只需要使用其中的一小段代码, 考虑将其分割为更加简短并易于管理的若干函数.
引用参数
- 所有按引用传递的参数必须加上
const
.
在 C 语言中, 如果函数需要修改变量的值, 参数必须为指针, 如
int foo(int *pval)
. 在 C++ 中, 函数还可以声明为引用参数:int foo(int &val)
.函数参数列表中, 所有引用参数都必须是
const
:void Foo(const string &in, string *out);
事实上这在 Google Code 是一个硬性约定: 输入参数是值参或
const
引用, 输出参数为指针. 输入参数可以是const
指针, 但决不能是非const
的引用参数, 除非特殊要求, 比如swap()
.有时候, 在输入形参中用
const T*
指针比const T&
更明智. 比如:- 可能会传递空指针.
- 函数要把指针或对地址的引用赋值给输入形参.
总而言之, 大多时候输入形参往往是
const T&
. 若用const T*
则说明输入另有处理. 所以若要使用const T*
, 则应给出相应的理由, 否则会使得读者感到迷惑. - 所有按引用传递的参数必须加上
-
RE: Google C++ style学习笔记
类(TODO)
- 不在构造函数中做太多逻辑相关的初始化
- 存取函数一般内联在头文件中
结构体 vs 类
仅当只有数据成员时使用
struct
, 其它一概使用class
.声明顺序
- 将相似的声明放在一起, 将
public
部分放在最前.
类定义一般应以
public:
开始, 后跟protected:
, 最后是private:
. 省略空部分.在各个部分中, 建议将类似的声明放在一起, 并且建议以如下的顺序: 类型 (包括
typedef
,using
和嵌套的结构体与类), 常量, 工厂函数, 构造函数, 赋值运算符, 析构函数, 其它函数, 数据成员.不要将大段的函数定义内联在类定义中. 通常,只有那些普通的, 或性能关键且短小的函数可以内联在类定义中.