C/C++编程规范与最佳实践
需积分: 14 24 浏览量
更新于2024-08-01
收藏 83KB DOC 举报
"C/C++编程规范总结,包括变量命名、常量命名和宏定义、函数命名、结构体命名以及结构化编码约定,适用于Visual C++, Borland C++, GNC等开发环境。"
C/C++编程规范是提高代码可读性、可维护性和团队协作效率的重要指南。以下是根据给定内容提炼出的一些关键知识点:
1. **变量命名**:
- 推荐使用匈牙利命名法,即在变量名前加上表示范围、类型和限定词的前缀。
- 类型前缀如`LmClass`表示类型本身,`IInterface`表示接口。
- 全局变量前缀`g_`,成员变量前缀`m_`,局部变量前缀`l_`(但应尽量避免使用全局变量)。
- 对特定模块的变量,可以使用模块名作为前缀,例如`Fea`、`Sket`、`Asm`、`Lay`、`Surf`和`Ui`。
2. **常量命名和宏定义**:
- 常量通常全大写,单词间用下划线分隔,如`MAX_SIZE`。
- 宏定义也遵循类似规则,但应谨慎使用宏,因为它们可能导致预处理问题。
3. **函数命名**:
- 函数命名通常遵循驼峰命名法,如`functionName`,首字母大写每个单词。
- 对于类的成员函数,如果需要调用非成员函数,应使用作用域解析运算符`::`。
4. **结构体命名**:
- 结构体命名一般遵循驼峰命名法,首字母大写,如`StructName`。
5. **结构化编码约定**:
- 源代码文件(.h/.cpp)开头应有统一格式的说明。
- 主要功能函数需添加注释说明其功能和用法。
- 代码宽度推荐为80列,最多不超过120列,折行应保持对齐。
- 循环和分支结构中,判断条件与执行代码应分开写在不同行。
- 指针定义时,`*`号位置可灵活放置。
- 函数参数有默认值时,需提供注释说明。
- `elseif`应写在新的一行。
- `{` 和 `}` 两侧的代码应保持一致的缩进。
- 使用空格增强代码可读性,例如在操作符周围添加空格。
- 缩进规则应保持一致,例如使用4个空格或一个制表符。
- 调用系统功能时,应使用系统提供的宏,避免直接使用具体数值。
- 函数编写应遵循一定的逻辑结构和清晰的注释。
6. **其他规定**:
- 鼓励使用类的实例命名来表达实例的具体语义,如`_StartPoint`和`_EndPoint`。
- 特殊类派生或特定用途的类,可以有特定的前缀,如`_Mt`、`CDlg`和`_Rb`。
遵循这些规范能帮助开发者编写出更易读、更易于理解和维护的代码,同时也能提升团队之间的协作效率。在实际开发中,还应结合项目需求和个人或团队习惯适当调整。
2017-08-19 上传
2023-07-15 上传
2023-06-20 上传
2023-08-16 上传
2023-06-23 上传
2023-09-14 上传
2023-07-03 上传
2023-07-14 上传
2023-07-18 上传
长寿梦
- 粉丝: 47
- 资源: 43
最新资源
- 明日知道社区问答系统设计与实现-SSM框架java源码分享
- Unity3D粒子特效包:闪电效果体验报告
- Windows64位Python3.7安装Twisted库指南
- HTMLJS应用程序:多词典阿拉伯语词根检索
- 光纤通信课后习题答案解析及文件资源
- swdogen: 自动扫描源码生成 Swagger 文档的工具
- GD32F10系列芯片Keil IDE下载算法配置指南
- C++实现Emscripten版本的3D俄罗斯方块游戏
- 期末复习必备:全面数据结构课件资料
- WordPress媒体占位符插件:优化开发中的图像占位体验
- 完整扑克牌资源集-55张图片压缩包下载
- 开发轻量级时事通讯活动管理RESTful应用程序
- 长城特固618对讲机写频软件使用指南
- Memry粤语学习工具:开源应用助力记忆提升
- JMC 8.0.0版本发布,支持JDK 1.8及64位系统
- Python看图猜成语游戏源码发布