C++编码规范:常量、宏与命名规则
需积分: 15 168 浏览量
更新于2024-08-19
收藏 196KB PPT 举报
"C++编码规范"
在C++编程中,遵循良好的编码规范是至关重要的,因为它可以提高代码的可读性、可维护性和减少潜在的错误。本规范主要涉及了常量、宏、枚举类型、文件命名、函数命名、存储类型和变量命名等方面。
1. 常量与宏:
- 规则1:常量、宏和枚举类型的定义应全用大写字母,各单词之间使用下划线分隔。例如,一个表示最大值的常量可以命名为`MAX_VALUE`,一个宏定义可以是`DEBUG_MODE`,枚举类型可能是`ColorTypes`。
- 规则2:这些定义必须清晰易懂,如果无法从名字直接理解其意义,应当添加注释来解释其用途。例如,`MAX_VALUE`的注释可能是`// The maximum allowed value for a given variable.`
2. 文件命名:
- 文件名应反映其内容,同一类或一组函数的头文件和实现文件应有相同的基名,但扩展名不同,如`.cpp`和`.hpp`。
- 类的头文件和实现文件应以类名为基名,如`ClassName.hpp`和`ClassName.cpp`。
- 功能相关的非类文件应以功能描述为基名,如`function_declaration.hpp`和`function_implementation.cpp`。
3. 函数命名:
- 函数名应清晰描述其功能,使用动宾词组,如`calculateSum`。每个单词首字母大写,采用驼峰式命名。
- 相互对立的函数,如开启和关闭,应使用反义词组命名。
- 避免在函数名中使用下划线。
4. 存储类型:
- 类、结构体和类型定义应以大写字母开头。类以"C"开头,结构以"S"开头,如`class MyClass`,`struct MyStruct`。
5. 变量命名:
- 禁止使用单个字符作为变量名,除非在循环中作为计数器(如`i`, `j`, `k`)。
- 避免使用数字或特殊字符来命名变量,确保名字有意义。
- 使用注释来解释特殊约定或缩写的含义。
- 全局变量需要详尽的注释,说明其功能、取值范围、访问函数以及注意事项。
- 推荐使用匈牙利命名约定或标准缩写法,以指示变量类型和作用,但不要通过大小写来区分变量。
6. 缩写规则:
- 当变量名字过长时,可以使用标准缩写,如`Cmptr`代替`Computer`。
- 非大写元音字母通常会被省略,以缩短名称。
遵循这些规范将有助于创建出高质量、易于理解和维护的C++代码,提高团队协作效率,并降低因命名不清晰导致的误解和错误。
740 浏览量
2018-09-06 上传
1883 浏览量
2023-11-07 上传
2023-06-08 上传
2023-06-08 上传
2023-05-24 上传
2023-09-27 上传
2024-09-19 上传
琳琅破碎
- 粉丝: 19
- 资源: 2万+
最新资源
- Android圆角进度条控件的设计与应用
- mui框架实现带侧边栏的响应式布局
- Android仿知乎横线直线进度条实现教程
- SSM选课系统实现:Spring+SpringMVC+MyBatis源码剖析
- 使用JavaScript开发的流星待办事项应用
- Google Code Jam 2015竞赛回顾与Java编程实践
- Angular 2与NW.js集成:通过Webpack和Gulp构建环境详解
- OneDayTripPlanner:数字化城市旅游活动规划助手
- TinySTM 轻量级原子操作库的详细介绍与安装指南
- 模拟PHP序列化:JavaScript实现序列化与反序列化技术
- ***进销存系统全面功能介绍与开发指南
- 掌握Clojure命名空间的正确重新加载技巧
- 免费获取VMD模态分解Matlab源代码与案例数据
- BuglyEasyToUnity最新更新优化:简化Unity开发者接入流程
- Android学生俱乐部项目任务2解析与实践
- 掌握Elixir语言构建高效分布式网络爬虫