C++ 代码风格

这是 Gluten 的一套 C++ 核心准则。其目的是通过提倡一致性和遵循最佳实践，使代码库更简洁、更高效、更易于维护。

哲学理念

哲学层面的准则通常难以量化衡量，但它们非常有价值。针对 Gluten 的 C++ 编码，有以下几条哲学准则。

C++ 编码风格的许多方面都将由 clang-format 覆盖，例如空格、行宽、缩进以及排序（包括 include、using 指令等）。

要格式化 CMake 文件（如 CMakeLists.txt 和 *.cmake），需要安装 cmake-format。以下是一个示例。

apt install python3-pip -y
pip3 install --user cmake-format
cmake-format --first-comment-is-literal True --in-place cpp/velox/CMakeLists.txt

所有头文件必须使用 #pragma once 包含单一包含保护（include guard）
始终使用 .h 作为头文件后缀，而不是 .hpp。
始终使用 .cc 作为源文件后缀，既不用 .cpp 也不用 .cxx。
一个文件应只包含一个主要类，且文件名应与主要类名保持一致。
- 明显的例外：用于定义各种杂项函数的文件。
如果一个头文件有对应的源文件，它们应具有相同的文件名，仅后缀不同，例如 a.h vs a.cc。
如果函数在文件 a.h 中声明，应确保它在对应的源文件 a.cc 中定义，不要在其他文件中定义。
CPP 文件不应有深层的源码目录结构，不要像 JAVA 那样组织。
包含头文件应满足以下规则。
- 包含必要的头文件，即仅包含一行 #include "test.h" 的源文件（.cc）应能在不包含任何其他头文件的情况下成功编译。
- 不要包含任何不必要的头文件，包含越多，编译越慢。
- 总之，不多不少，按需包含。

使函数简短且简单。
调用一个有意义的函数比原地编写过多语句更具可读性，但性能敏感的代码路径除外。
给函数起一个好名字，如何判断函数名是否好。
- 大声读出来时感觉通顺。
- 能够通过参数表示的信息不应编码进函数名中。例如，使用 get(size_t index) 而不是 getByIndex。
一个函数应专注于单一的逻辑操作。
函数应做到与名称含义相符。
- 完成函数名所涵盖的所有事情
- 不做函数名未涵盖的任何事情

使用句柄和 RAII 自动管理资源。
立即将显式资源分配的结果交给管理对象。
优先使用作用域对象和栈对象。
使用裸指针表示单个对象。
如果不想使用容器，请使用 pointer + size_t 表示数组对象。
裸指针（即 T*）是非拥有性的。
裸引用（即 T&）是非拥有性的。
理解 unique_ptr、shared_ptr、weak_ptr 之间的区别。
- unique_ptr 表示所有权，但不表示共享所有权。unique_ptr 等价于 RAII，即在对象析构时释放资源。
- shared_ptr 表示基于使用计数的共享所有权，其开销比 unique_ptr 更大。
- weak_ptr 建模临时所有权，有助于打破由 shared_ptr 管理的对象所形成的引用循环。
使用 unique_ptr 或 shared_ptr 表示所有权。
除非需要共享所有权，否则优先使用 unique_ptr 而非 shared_ptr。
使用 make_unique 创建 unique_ptr。
使用 make_shared 创建 shared_ptr。
仅在需要显式表达生命周期语义时，才将智能指针作为参数。
对于一般用途，应使用 T* 或 T& 参数，而不是智能指针。