上海SMISOL C/C++编码规范
版权申诉
126 浏览量
更新于2024-08-20
收藏 139KB PDF 举报
"某知名软件公司内部C++开发标准分享.pdf"
这篇文档是上海SMISOL公司的C/C++代码编写规范,版本为1.1,旨在规范编程人员在编写C++代码时的风格和结构,以实现代码的标准化,增强代码的可读性、理解和维护性。规范特别强调了命名规则,这是确保代码一致性的重要因素。
首先,规范指出命名应使用英文,且单词简洁、清晰,避免使用难以理解的缩写、汉语拼音或人名。采用驼峰命名法,即每个单词首字母大写,单词间不加空格而是直接连接,且定语应置于被修饰语之前。对于变量,推荐使用匈牙利命名法,并提供复杂的变量类型、类和结构的统一缩写原则。命名的长度应兼顾最小长度和最大信息量,长名字通常能更准确地表达含义,但也有例外,例如局部变量常使用i, j, k, m, n, x, y, z等简短符号。
在工程命名上,所有项目名称前需加上大写的"SS"(代表ShangHaiSmisol),以表明其为SMISOL公司的项目。例如,如果项目意义名称为Model,则工程命名为SSModel,对应的VisualC++工程文件名为SSModel.dsp。
对于类(CLASS)的命名,规范要求所有类名必须以"CSS"开头,后面的单词首字母大写,如CSSImage。类的头文件和源文件名称遵循VC规则,去掉"C",如SSImage.h和SSImage.cpp。
在函数命名方面,分为全局函数和类成员函数。全局函数的命名应遵循"限定名词+动词[+名词]"的模式,例如longRmodelGetCenter(double&x, double&y),其中Rmodel是限定名词,Get是动词,Center是名词,限定名词需根据工程名称统一规定。对于类成员函数的命名,虽然没有给出具体的例子,但通常遵循的规则是方法名应体现其所属类的功能,可能包括对象的动作和影响的对象。
这些规则的实施旨在提高代码质量,降低团队协作中的误解,提升代码的可维护性和可扩展性。通过统一的编码规范,可以提高软件开发的效率,减少因为命名不一致或编码风格混乱导致的问题,使得整个项目的开发更为顺畅。
2022-02-06 上传
2021-09-30 上传
2021-09-13 上传
2021-08-05 上传
124 浏览量
2021-10-15 上传
2023-03-11 上传
2021-10-10 上传
2020-12-21 上传
XWJcczq
- 粉丝: 2
- 资源: 7万+
最新资源
- 基于Python和Opencv的车牌识别系统实现
- 我的代码小部件库:统计、MySQL操作与树结构功能
- React初学者入门指南:快速构建并部署你的第一个应用
- Oddish:夜潜CSGO皮肤,智能爬虫技术解析
- 利用REST HaProxy实现haproxy.cfg配置的HTTP接口化
- LeetCode用例构造实践:CMake和GoogleTest的应用
- 快速搭建vulhub靶场:简化docker-compose与vulhub-master下载
- 天秤座术语表:glossariolibras项目安装与使用指南
- 从Vercel到Firebase的全栈Amazon克隆项目指南
- ANU PK大楼Studio 1的3D声效和Ambisonic技术体验
- C#实现的鼠标事件功能演示
- 掌握DP-10:LeetCode超级掉蛋与爆破气球
- C与SDL开发的游戏如何编译至WebAssembly平台
- CastorDOC开源应用程序:文档管理功能与Alfresco集成
- LeetCode用例构造与计算机科学基础:数据结构与设计模式
- 通过travis-nightly-builder实现自动化API与Rake任务构建