C++代码规范

  1. 基本原则
  • 统一使用项目规定的 C++ 标准,建议 C++17 或更高版本。
  • 开启编译器警告并及时处理,代码优先保证清晰、可维护。
  1. 命名
  • 类型、类、枚举使用 PascalCase;变量、函数、命名空间使用 snake_case。
  • 成员变量使用尾部下划线,如 count_;常量使用 kPascalCase。
  • 布尔值使用 is_、has_、can_ 等前缀,避免无意义缩写。
  1. 格式与文件组织
  • 使用 clang-format,缩进 4 个空格,禁止 Tab。
  • 一行只写一条语句,单行建议不超过 100~120 个字符。
  • 头文件使用 #pragma once,按“对应头文件、标准库、第三方库、项目头文件”的顺序包含。
  1. 类型与接口
  • 优先使用 const、constexpr、enum class、标准容器和 nullptr。
  • 类型明显时可使用 auto,公共接口应写明类型。
  • 避免隐式窄化、符号转换和 C 风格强制转换。
  1. 资源管理
  • 使用 RAII 管理资源,禁止直接使用裸 new/delete。
  • 独占所有权使用 std::unique_ptr,确需共享时才使用 std::shared_ptr。
  • 裸指针默认表示非拥有引用。
  1. 错误处理与注释
  • 按项目约定统一使用异常或状态返回。
  • 不得静默忽略错误,捕获异常后必须处理或重新抛出。
  • 注释说明“为什么”和限制条件,不重复代码内容。
  1. 提交前检查
  • 执行格式化、编译、单元测试和静态检查。
  • 不提交临时文件、密钥、调试代码和生成物。
posted @ 2026-10-13 20:43  言语123  阅读(3)  评论(0)    收藏  举报