当前位置：首页 > news >正文

C++里的代码命名规范

news 2025/12/26 4:44:56

以下是 C++ 中最主流的几种命名规范：

1. 蛇形命名法

这是 C++ 标准库和许多 C++ 社区（如 Boost）最推荐的风格。

小写蛇形命名法：所有字母小写，单词之间用下划线 _ 连接。

适用于：变量、函数、命名空间、文件。

示例：

std::string first_name; // 变量
void calculate_total_price(); // 函数
namespace my_project_utilities { // 命名空间// ...
}
// 文件名：my_awesome_class.h

大写蛇形命名法：所有字母大写，单词之间用下划线 _ 连接。

适用于：宏、常量。

示例：

#define MAX_BUFFER_SIZE 1024 // 宏
const double PI = 3.14159; // 常量（有时也用，但小写蛇形也很常见）
const int DEFAULT_TIMEOUT = 30;

2. 驼峰命名法

这种风格在 Java、C# 中非常流行，在一些 C++ 项目（尤其是与 Qt 相关的）中也经常使用。

小驼峰命名法：第一个单词首字母小写，后续每个单词首字母大写。
- 适用于：变量、函数。
- 示例：
```
std::string firstName; // 变量
void calculateTotalPrice(); // 函数
```

大驼峰命名法：每个单词的首字母都大写。

适用于：类名、结构体、枚举类型。

示例：

class MyClass { // 类
public:void PublicMethod();
private:int m_memberVariable; // 成员变量常加前缀，见下文
};struct UserAccount { // 结构体int id;std::string name;
};enum class Color { // 枚举类Red,Green,Blue
};

综合建议与最佳实践

一个综合了各方优点的、实用的命名规范示例：

// 宏（全大写，蛇形）
#define LOG_LEVEL_DEBUG 1// 命名空间（小写蛇形）
namespace my_library {
namespace internal { // 内部实现细节的命名空间// 类名（大驼峰，或小写蛇形均可，但大驼峰更常见）
class NetworkManager {
public:// 公有函数（小写蛇形）void connect_to_server();bool is_connected() const; // 返回bool的函数名最好有"is_", "has_"等前缀// 类型别名（小写蛇形，或以 `_t` 结尾）using socket_handle_t = int;private:// 私有成员变量（小写蛇形，有时会加 `m_` 前缀以区分局部变量）std::string m_server_address;int m_port_number;bool m_is_connected;// 或者不加前缀，直接用蛇形// std::string server_address_;// int port_number_;
};// 结构体（通常小写蛇形，如果主要是公有数据成员）
struct user_info {int id;std::string first_name;std::string last_name;
};} // namespace internal// 自由函数（小写蛇形）
void helper_function() {// 局部变量（小写蛇形）int retry_count = 0;const int max_retries = 5; // 常量（小写蛇形或大写蛇形均可）// ...
}// 枚举类（枚举类型名用大驼峰，枚举值用小写蛇形）
enum class HttpStatus {ok = 200,not_found = 404,internal_server_error = 500
};} // namespace my_library

总结

代码元素	推荐规范（主流C++风格）	备选规范（如Qt/Java风格）
类/结构体	`MyClass` (大驼峰) 或 `my_class` (小写蛇形)	`MyClass` (大驼峰)
函数	`my_function` (小写蛇形)	`myFunction` (小驼峰)
变量	`my_variable` (小写蛇形)	`myVariable` (小驼峰)
成员变量	`m_my_variable` 或 `my_variable_` (加前缀/后缀)	`m_myVariable`
常量	`MY_CONSTANT` (大写蛇形) 或 `my_constant` (小写蛇形)	`myConstant` (小驼峰)
枚举值	`enum_value` (小写蛇形)	`EnumValue` (大驼峰)
命名空间	`my_namespace` (小写蛇形)	`myNamespace` (小驼峰)
宏	`MY_MACRO` (大写蛇形)	`MY_MACRO` (大写蛇形)