Debian C++代码风格规范

Debian C++代码风格规范
Debian项目中的C++代码风格遵循通用C++编码标准，旨在提升代码一致性、可读性与可维护性。以下是核心规范要点：

1. 命名约定

• 类名：使用大驼峰命名法（Pascal Case），如MyClass；
• 函数与变量：使用小驼峰命名法（camelCase），如myMethod、myVariable；
• 常量：全部字母大写，单词间用下划线分隔，如const double PI = 3.14159265358979323;；
• 私有数据成员：以m_为前缀，如m_width、m_height（明确标识类内部状态）；
• 函数参数：以t_为前缀，如t_inputValue（区分参数与局部变量，避免命名冲突）；
• 命名禁忌：避免使用下划线_开头（可能与编译器或标准库保留名冲突）。

2. 代码格式规范

• 缩进：每个缩进级别使用4个空格（不使用制表符Tab，防止不同编辑器显示差异）；
• 空格使用：
  • 关键字与左括号之间加空格（如if (、for (），增强语句可读性；
  • 函数名与左括号之间不加空格（如myFunction()），符合常见函数调用视觉习惯；
  • 逗号后加空格（如func(arg1, arg2)），分隔参数或列表项；
  • 二元/三元运算符两侧加空格（如a + b、a ? b : c），明确运算优先级；
  • 大括号内部两侧不加空格（如if (condition) {），保持紧凑结构。
• 大括号放置：
  • 函数大括号：左大括号放在函数名下一行开头（如void myFunction() {），右大括号单独成行；
  • 其他大括号（如if/for/while）：左大括号紧跟语句末尾（如if (condition) {），右大括号单独成行。
• 行长度：建议每行不超过80字符（部分项目允许120字符，但需避免过长导致换行混乱）；超过时在低优先级操作符后换行，操作符留在行尾，新行按同类对齐。

3. 特殊符号与关键字规范

• 空指针：使用nullptr代替传统0或NULL（nullptr是C++11引入的类型安全空指针，避免隐式类型转换问题）；
• 注释：单行注释使用//（如// 计算两个数的和），避免使用/* */（减少嵌套注释的复杂性）；
• auto关键字：简化类型声明（如auto it = vec.begin();），但不用于局部变量之外（如全局变量、类成员），确保类型清晰可追踪。

4. 代码组织规范

• 文件分离：构建生成的文件（如.o、.a、可执行文件）存放在与源文件夹分离的输出目录（如build/），避免源代码与生成文件混杂；
• 前缀一致性：为团队项目选择统一的前缀或后缀（如debian_前缀的模块名），保持项目结构整齐。

5. 其他重要规范

• 变量初始化：所有变量在使用前必须初始化（如int count = 0;、std::string name;），避免未定义行为（如读取未初始化内存）；
• 函数设计：保持函数短小精悍，每个函数仅完成单一功能（如calculateSum()只负责求和，不包含输入输出逻辑）；
• const使用：用const修饰不变量（如const int MAX_SIZE = 100;）、函数参数（如void printValue(const std::string& value)）和成员函数（如int getValue() const），提高代码安全性与可读性；
• 模板简化：避免过度使用复杂模板编程（如多层嵌套模板、特化），优先使用简单明确的代码结构（如标准库容器std::vector、std::map），提升代码可维护性。