Ubuntu C++代码风格有何建议

Ubuntu下C++代码风格建议

1. 代码排版与缩进

• 缩进：推荐使用4个空格进行缩进（避免使用Tab键，防止不同编辑器显示不一致）。
• 换行：每行代码长度建议不超过80个字符（部分项目可能放宽至120字符），超过后需换行，换行后对齐逻辑层次（如参数列表、运算符对齐）。
• 空格：运算符两边必须加空格（如a + b、x == y）；函数名与参数列表之间的逗号后加空格（如func(int a, int b)）；关键字（如if、for、while）与括号之间不加空格（如if (condition)）。
• 大括号：结构体、if/for/while/switch等语句的大括号不另起一行（如if (x > 0) { ... }）；函数的大括号需另起一行（如int func() { ... }）。

2. 命名规范

• 变量与函数：使用小写字母+下划线组合（snake_case），如user_name、calculate_sum。变量名优先使用名词或形容词+名词（如value、old_value）；函数名优先使用动词或动词+名词（如get_data、set_name）。
• 常量：全部使用大写字母+下划线组合（UPPER_CASE），如MAX_SIZE、PI_VALUE。
• 类名：使用大驼峰命名法（PascalCase），如MyClass、UserManager。
• 宏定义：全部使用大写字母+下划线组合（UPPER_CASE），如MAX_BUFFER_SIZE、DEBUG_MODE。
• 私有成员变量：建议添加m_前缀（如m_age、m_name），以区分公共成员与私有成员。

3. 注释规范

• 单行注释：使用//，注释内容需简洁明了，解释代码的目的而非简单重复代码逻辑（如// 计算两个数的和而非// a + b）。
• 多行注释：使用/* */，用于较长的注释（如类、函数的详细说明）。
• 类注释：每个类的定义前需添加注释，说明类的功能、用法及注意事项（如// 用户管理类，负责用户的增删改查操作）。
• 函数注释：函数声明处注释需说明函数功能、参数含义、返回值；函数定义处注释需补充实现要点（如使用的算法、关键步骤）（如// 获取用户信息，参数为user_id，返回User对象）。

4. 函数设计

• 单一职责：每个函数只做一件事，避免函数承担过多功能（如将“用户登录”拆分为“验证用户名”“验证密码”两个函数）。
• 函数长度：函数体尽量控制在50行以内，过长的函数需拆分（可通过提取子函数实现）。
• 参数传递：优先使用const &传递对象（避免拷贝开销，如void print_user(const User& user)）；输入参数为基本类型（如int、double）时可使用值传递；避免过多的函数参数（建议不超过5个，过多时可使用结构体封装）。
• 错误处理：使用异常（try-catch）替代exit()函数，确保错误能被上层调用捕获并处理（如throw std::runtime_error("Invalid input")）。

5. 代码结构

• 头文件与源文件分离：将类的声明放在.h文件中，实现放在.cpp文件中（如user.h与user.cpp），避免头文件中包含过多实现细节（如内联函数除外）。
• 命名空间：使用std命名空间避免重复写std::（如using namespace std;），但在头文件中应避免使用（防止污染全局命名空间）。
• 避免全局变量：尽量将变量定义在最小作用域内（如函数内部、类内部），减少全局变量的使用（全局变量会增加代码耦合度，难以维护）。

6. 工具辅助

• ClangFormat：使用ClangFormat工具自动格式化代码，确保风格一致。Ubuntu下可通过sudo apt install clang-format安装，配置文件（.clang-format）需在项目根目录下创建（参考C++社区标准或团队约定），支持调整缩进、换行、命名等风格。
• 编译器警告：启用编译器警告选项（如-Wall、-Wextra），并将警告视为错误（-Werror），提前发现代码中的潜在问题（如未使用的变量、类型不匹配）。