C++命名规范

1. 基本原则

• 保持一致性。
• 命名应具有描述性，并尽量避免使用缩写。
• 为常用的命名模式提供文档，使新成员或其他开发者能够快速上手。

2. 通用命名规则

• 使用英文命名。
• 使用驼峰命名法。

3. 类和结构

• 类名和结构名应该使用驼峰命名，首字母大写：MyClass, ImageData.

4. 变量

• 普通变量使用驼峰命名，首字母小写：localVariable.

• 类成员变量前加 _ 前缀：_memberVariable.

• 函数参数使用驼峰命名，并添加 _ 后缀：parameter_.

5. 函数

• 函数名使用驼峰命名，首字母小写：calculateAverage().

6. 常量和宏

• 常量使用驼峰命名，首字母大写：ConstValue.

• 宏使用全部大写，单词之间用下划线分隔：MAX_COUNT.

7. 文件名

• 文件名应反映其中的主要类或内容。例如，MyClass 类应该在 MyClass.cpp 和 MyClass.h 中定义。

8. 名称选择

• 避免使用C++关键字或与常用库冲突的名称。

• 名称应具体且具有描述性，例如，使用 openFile() 而不是 open()，除非在上下文中很明确。

9. 注释

• 为所有公共API、函数、类和方法提供文档注释。

• 注释应简短且具体，清晰地描述函数或方法的行为、输入和输出。

10. 总结

这只是一个基本的命名规范。在实际开发中，根据项目和团队的具体情况，可能需要调整或扩展这些规则。最重要的是，团队中的每个成员都应遵循同一套规则，并确保代码在整个项目中保持一致性。