Pika 编程规范

[AlexStocks]

• 1 C++ 函数变量或者类成员，基本类型变量比如 bool、char、整型(int/unsigned etc)、浮点数(float/double)、指针(不包括 const 类型指针)，在声明时就进行零值初始化 fix: init every class member's value to defeat the redis-cli connection closed by pika #1390
• 2 尽量使用智能指针如 share_ptr、scope_ptr、unique_ptr，不要使用 New/Delete Fix: memory leak when RedisSets destructs Qihoo360/blackwidow#14 ；尽量使用 Pika 中封装的 Defer，防止 变量/文件 资源泄露
• 3 获取指针后，首先判断其是否为 nullptr，不要在判空前使用fix: access null pointer #1426 或者判空后还要接着使用fix: access null pointer #1414
• 4 每次提交代码前，在代码根目录通过命令 find . -iname *.h | xargs clang-format -i 与 "find . -iname *.cc | xargs clang-format -i"把代码格式化下
• 5 继承不要超过两层
• 6 不要使用可重入锁（递归锁）
• 7 命名风格
  • class 命名使用名词，大写开头；
  • class member 使用名词，小写，下划线式风格，最后字符保持为下划线；
  • class function 命名为 Verb + Noun，不要取名如 “KeyDelete” 这种二把刀式的命名，如果 func 为 public 则首字母大写，否则小写；
  • function var 命名使用名词，小写，下划线式风格，最后字符不得为下划线；
• 8 使用 auto 时，如果右值是 指针 或者 引用 形式，务必使用 “auto &” 形式，防止产生值赋值导致无法正确修改右值的引用，例子the right way to use 'auto' keyword 。
• 9 大家提交代码的时候规范下 commit message，遵循结构化语义化，也便于自动化生成 changelog 等，参考 https://www.conventionalcommits.org/en/v1.0.0/ 。issue 和 pr title 也尽量参考上面这个规范。最重要一条：commit message 尽量使用英文，别中文，至少保证 issue 和 pr title 是英文。
• 10 在 C++11 中已经引入 make_tuple 方便构建多返回值，pika 中以后存在多返回值时，使用 make_tuple 构建，编程示例：

      #include <iostream>  
      #include <tuple>
      std::tuple<int, std::string, double> make_tuple_example() {  
          int a = 1;  
          std::string b = "hello";  
          double c = 3.14;  
          return std::make_tuple(a, b, c);  
      }
      int main() {  
          std::tuple<int, std::string, double> t = make_tuple_example();  
          int x = std::get<0>(t);    // 获取 t 中的第一个元素，即 a  
          std::string y = std::get<1>(t);    // 获取 t 中的第二个元素，即 b  
          double z = std::get<2>(t);    // 获取 t 中的第三个元素，即 c
          std::cout << "x = " << x << std::endl;  
          std::cout << "y = " << y << std::endl;  
          std::cout << "z = " << z << std::endl;
      
         // OR 
      
          auto xx, yy, zz = make_tuple_example();
          std::cout << "x = " << xx << std::endl;
          std::cout << "y = " << yy << std::endl;
          std::cout << "z = " << zz << std::endl;
      
          return 0;  
      }

[lqxhub]

加一个 format_code.sh 的脚本吧, 有个问题是 要不要通过脚本 把

find . -iname *.h | xargs clang-format -i 
find . -iname *.cc | xargs clang-format -i

自动加到 git的 pre-commit hook脚本中

[lqxhub]

没问题，我现在想到两个方案

1. 每次提交前手动运行 format_code.sh 脚本来格式代码
2. 执行format_code.sh 后 如果检测到本机有clang-format程序 把 格式化相关的命令写入 git 的pre-commit hook脚本中 后续每次提交前都会自动格式化代码

用哪种会好点

[AlexStocks]

怎么感觉你这两个步骤是可以衔接起来嘛

[lqxhub]

区别是第一种需要每次提交前手动运行一次脚本, 第二种是 只需要运行一次脚本就可以, 后续会通过git 的hook自动格式化

[AlexStocks]

那就第二种吧

[lqxhub]

OK, 明天搞一下

[longfar-ncy]

Pika 发展迅速，为进一步规范 Pika 社区，提出以下几点命名规则。整体还是基于 Google Style，这里主要强调一些不同点和容易忽略的点：

• 类成员函数：命名为 Verb + Noun，避免如 “KeyDelete” 这种二把刀式的命名； public 首字母大写，private 和 protected 首字母小写；

• 全局变量：lower_case，但是要加前缀 g_pika_（如 PikaServer* g_pika_server）；

• 全局常量：按照 Google Style：kCamelCase （如 const int32_t kDBSyncMaxGap）；

• 类成员常量：同全局常量；

• 局部常量：由于之前的代码局部常量都没有按照 kCamelCase 命名，这次不做要求，但建议采用 kCamelCase 形式命名；

• 宏定义：建议尽可能避免宏定义，但若无法避免，则采用 UPPER_CASE 形式命名（如#define PIKA_MAX_WORKER_THREAD_NUM 24）；

• 枚举：以往代码枚举格式采用 kCamelCase 的形式较多，因此以后规定使用 kCamelCase，同全局常量（如下）；

  enum ResponseStatus {
      kPrepareHeader,
      kSendingHeader,
      kSendingBody,
  };

• 尽可能使用int16_t, int32_t, int64_t 代替 short, int, long，使用 uint16_t, uint32_t, uint64_t 代替 unsigned short, unsigned int, unsigned long

[georgehao]

整体上很好。

https://github.com/google/styleguide
https://github.com/cpplint/cpplint

看看这两个 lint 是否有帮助。

[chejinge]

建议：
1.优先编译时检查错误：
a.通过const来保证数据的不变性，尽可能少的使用宏定义
b.static_insert进行编译时检查
2.禁止if/else/else if写在同一行
3.多个变量定义和赋值不允许写在同一行
4.代码注释
a.代码注释放于对应代码的上方或者右边
b.注释符与注释内容之间要有1个空格，右置注释与前面代码至少一个空格
5.头文件
a.禁止包含使用不到的头文件，防止引入不必要依赖，减少模块之间的耦合度(只要头文件被修改，代码就需要重新编译)。
b.尽量避免头文件循环依赖
c.头文件应该自包含(任意一个头文件均可独立编译)
d.头文件包含顺序：cpp对应头文件，C 系统库.h，C++标准库，第三方.h，本项目内其他的.h
6.常量与初始化：
a.不允许使用宏来表示常量
b.一组相关的整形常量应该被定义为枚举类型
c.不允许使用魔鬼数字
d.常量应该保持单一职责，一个常量不允许有多种用途
e.变量尽量在使用时声明初始化，遵循变量的作用域最小化原则和就近声明原则
7.循环语句
循环语句要求使用大括号
badcase: for(int i = 0; i < someRange; i++); // for循环体哪怕是空也要使用大括号
8.表达式
表达式换行要保持换行一致性，运算符放在行末
9.指针与引用：
a.指针类型"*"跟随变量名或者类型，不要两边都留或者都没空格
b.引用类型"&"跟随变量名或者类型，不要两边都留或者都没空格

[AlexStocks]

在 C++11 中已经引入 make_tuple 方便构建多返回值，pika 中以后存在多返回值时，使用 make_tuple 构建，编程示例：

#include <iostream>  
#include <tuple>
std::tuple<int, std::string, double> make_tuple_example() {  
    int a = 1;  
    std::string b = "hello";  
    double c = 3.14;  
    return std::make_tuple(a, b, c);  
}
int main() {  
    std::tuple<int, std::string, double> t = make_tuple_example();  
    int x = std::get<0>(t);    // 获取 t 中的第一个元素，即 a  
    std::string y = std::get<1>(t);    // 获取 t 中的第二个元素，即 b  
    double z = std::get<2>(t);    // 获取 t 中的第三个元素，即 c
    std::cout << "x = " << x << std::endl;  
    std::cout << "y = " << y << std::endl;  
    std::cout << "z = " << z << std::endl;

   // OR 

    auto xx, yy, zz = make_tuple_example();
    std::cout << "x = " << xx << std::endl;
    std::cout << "y = " << yy << std::endl;
    std::cout << "z = " << zz << std::endl;

    return 0;  
}