Google C++ Style Guide
C++ 编程规范是一套为了提升代码可读性、可维护性和可扩展性的指南,特别适合团队开发和大型项目。以下是通用且推荐遵循的 C++ 编程规范汇总,涵盖命名、结构、注释、风格等关键点:
🔷 一、命名规范
✅ 变量 / 成员变量:
-
使用小写字母,单词间用下划线分隔(snake_case)
-
类的私有成员变量一般加
_
结尾(如speed_
) -
int max_speed; float current_speed_;
✅ 类名 / 结构体名:
-
每个单词首字母大写(PascalCase)
class RobotController;
struct PositionData;
✅ 函数名:
-
使用驼峰式命名(camelCase),首字母小写
void computeVelocity();
float getDistanceToGoal();
✅ 宏定义:
-
全大写 + 下划线分隔
#define MAX_BUFFER_SIZE 1024
🔷 二、代码结构规范
✅ 类定义顺序推荐:
class Example {
public:// 构造函数 / 析构函数Example();~Example();// 公有方法void publicMethod();protected:// 受保护方法/变量private:// 私有方法/变量int internal_value_;
};
✅ 文件组织:
-
一个类一个
.cpp
+.h
-
.h
只包含声明,不写实现 -
#pragma once
用于头文件防重包含
🔷 三、注释风格
✅ 单行注释:
// 计算速度向量
✅ 多行注释:
/** 初始化机器人控制器* 参数:* config_path: 配置文件路径*/
✅ 函数注释建议使用 Doxygen 风格(推荐):
/*** @brief 计算目标点距离* @param target_x 目标 X 坐标* @param target_y 目标 Y 坐标* @return 返回距离(单位:米)*/
float computeDistance(float target_x, float target_y);
🔷 四、代码风格
-
缩进: 使用 4 个空格(不要用 Tab)
-
大括号: 建议独占一行
if (condition) {doSomething(); }
-
空格: 保持清晰
int a = 5; for (int i = 0; i < n; ++i) { ... }
🔷 五、安全与性能建议
-
使用
const
修饰不变变量或引用参数 -
避免裸指针,推荐使用智能指针(
std::unique_ptr
,std::shared_ptr
) -
使用范围
for
循环优先for (const auto& item : container) { ... }
-
避免魔法数字,使用
constexpr
或const
变量替代
🔷 六、C++11/14/17 推荐实践
-
用
auto
简化类型 -
用
nullptr
替代NULL
-
使用
enum class
替代传统enum
-
使用
override
/final
明确虚函数行为 -
使用 RAII 资源管理(如
std::lock_guard
)