约定

本节提供了一些关于我们用于解决 C++ 项目许多部分共有问题的抽象和开发方法的信息。

文件命名

C++ 源文件和头文件应使用下划线而不是连字符来分隔单词。然而，编译后的可执行文件将自动使用连字符（例如，src/arrow/scalar_test.cc 将编译成 arrow-scalar-test）。

C++ 头文件使用 .h 扩展名。任何不包含 internal 的头文件都被视为公共头文件，并将在构建时自动安装。

注释和文档字符串

普通注释以 // 开头。

Doxygen 文档字符串以 /// 开头，Doxygen 指令以 \ 开头，例如这样

/// \brief Allocate a fixed size mutable buffer from a memory pool, zero its padding.
///
/// \param[in] size size of buffer to allocate
/// \param[in] pool a memory pool
ARROW_EXPORT
Result<std::unique_ptr<Buffer>> AllocateBuffer(const int64_t size,
                                               MemoryPool* pool = NULLPTR);

文档字符串的摘要行使用不定式，而不是指示性动词（例如，“分配缓冲区”而不是“分配一个缓冲区”）。

内存池

我们通过 arrow::default_memory_pool() 提供一个默认内存池。

错误处理和异常

为了处理错误，我们返回 arrow::Status 值，而不是抛出 C++ 异常。由于 Arrow C++ 库旨在作为大型 C++ 项目的组件，使用 Status 对象可以通过明确函数何时可能失败来帮助保持良好的代码卫生。

一个更新的选择是返回一个 arrow::Result<T> 对象，该对象可以表示带有 T 值的成功结果，或者带有 Status 值的错误结果。

为了表达内部不变量和“不能失败”的错误，我们使用在 arrow/util/logging.h 中定义的 DCHECK 宏。这些检查在发布版本中被禁用，旨在捕获内部开发错误，尤其是在重构时。这些宏不应包含在任何公共头文件中。

由于我们不使用异常，我们避免在对象构造函数中执行昂贵的工作。构造昂贵的对象通常可能具有私有构造函数，以及返回 Status 或 Result<T> 的公共静态工厂方法。

有一些对象构造函数，例如 arrow::Schema 和 arrow::RecordBatch，其中可能会创建较大的 STL 容器对象，例如 std::vector。虽然这些构造函数可能会抛出 std::bad_alloc，但发生这种情况的情况有些奇特，而且应用程序很可能在构造函数中抛出 std::bad_alloc 之前就已经遇到了其他更严重的问题。