没有合适的资源?快使用搜索试试~ 我知道了~
首页C++/C编程质量手册:高效与规范指南
C++/C编程质量手册:高效与规范指南
需积分: 3 0 下载量 42 浏览量
更新于2024-07-18
收藏 493KB PDF 举报
"《高质量C++/C编程指南》是一份详尽的文档,旨在提供开发C和C++程序时遵循的最佳实践和规范。作者林锐博士在2001年7月24日发布了该版本,文件包含多个章节,涵盖了编程的基础要素和高级主题。 1. 文件结构部分强调了版权声明、头文件组织、定义文件结构的重要性以及头文件的作用,提倡清晰的目录结构,以便于理解和维护。 2. 程序版式方面,详细指导了空行、代码行的规范、空格使用、对齐规则、长行拆分、修饰符位置和注释的编写标准,以及类的版式设计,确保代码可读性和一致性。 3. 命名规则部分,包括通用规则以及针对Windows和UNIX平台特定的应用程序命名策略,强调了命名的清晰和一致性。 4. 表达式和基本语句章节涉及运算符优先级、复合表达式、IF语句、循环控制(如FOR和SWITCH)、以及对于GOTO语句的谨慎使用,注重语法的正确性和效率。 5. 常量管理章节解释了常量的必要性,比较了CONST和#DEFINE的区别,并规定了常量定义的规则,特别提到了类中常量的使用。 6. 函数设计部分关注参数和返回值的规则,函数内部实现的规范,推荐使用断言来增强代码健壮性,以及引用和指针的异同。 7. 内存管理是文档的核心部分,讨论了内存分配的不同方式,如何避免常见错误,如指针和数组的关系,内存传递的方式,以及MALLOC/FREE和NEW/DELETE的合理运用,还提到了内存耗尽时的应对策略和MALLOC/FREE的使用要点,以确保程序的内存安全。 这份指南不仅适用于初学者,也对有经验的开发者提供了优化代码质量的重要参考,强调了在C和C++编程中的最佳实践,帮助开发者写出高效、可靠和易于维护的代码。"
资源详情
资源推荐
高质量 C++/C 编程指南,v 1.0
2001 Page 16 of 101
2.2 代码行
z 【规则 2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样
的代码容易阅读,并且方便于写注释。
z 【规则 2-2-2】if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论
执行语句有多少都要加{}。这样可以防止书写失误。
示例 2-2(a)为风格良好的代码行,示例 2-2(b)为风格不良的代码行。
int width; // 宽度
int height; // 高度
int depth; // 深度
int width, height, depth; // 宽度高度深度
x = a + b;
y = c + d;
z = e + f;
X = a + b; y = c + d; z = e + f;
if (width < height)
{
dosomething();
}
if (width < height) dosomething();
for (initialization; condition; update)
{
dosomething();
}
// 空行
other();
for (initialization; condition; update)
dosomething();
other();
示例 2-2(a) 风格良好的代码行 示例 2-2(b) 风格不良的代码行
【建议 2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)
如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用
了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。例如
int width = 10; // 定义并初绐化 width
int height = 10; // 定义并初绐化 height
int depth = 10; // 定义并初绐化 depth
高质量 C++/C 编程指南,v 1.0
2001 Page 17 of 101
2.3 代码行内的空格
z 【规则 2-3-1】关键字之后要留空格。象 const、virtual、inline、case 等关键字之后
至少要留一个空格,否则无法辨析关键字。象 if、for、while 等关键字之后应留一个
空格再跟左括号‘(’,以突出关键字。
z 【规则 2-3-2】函数名之后不要留空格,紧跟左括号‘(’,以与关键字区别。
z 【规则 2-3-3】‘(’向后紧跟,‘)’、‘,’、‘;’向前紧跟,紧跟处不留空格。
z 【规则 2-3-4】‘,’之后要留空格,如 Function(x, y, z)。如果‘;’不是一行的结束
符号,其后要留空格,如 for (initialization; condition; update)。
z 【规则 2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,
如“=”、“+=” “>=”、“<=”、“+”、“*”、“%”、“&&”
、“||”、“<<”,“^”等二元
操作符的前后应当加空格。
z 【规则 2-3-6】一元操作符如“!”、“~”、“++”、“--”、“&”(地址运算符)等前后不
加空格。
z 【规则 2-3-7】象“[]”、“.”、“->”这类操作符前后不加空格。
【建议 2-3-1】对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去
掉一些空格,如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))
void Func1(int x, int y, int z); // 良好的风格
void Func1 (int x,int y,int z); // 不良的风格
if (year >= 2000) // 良好的风格
if(year>=2000) // 不良的风格
if ((a>=b) && (c<=d)) // 良好的风格
if(a>=b&&c<=d) // 不良的风格
for (i=0; i<10; i++) // 良好的风格
for(i=0;i<10;i++) // 不良的风格
for (i = 0; I < 10; i ++) // 过多的空格
x = a < b ? a : b; // 良好的风格
x=a<b?a:b; // 不好的风格
int *x = &y; // 良好的风格
int * x = & y; // 不良的风格
array[5] = 0; // 不要写成 array [ 5 ] = 0;
a.Function(); // 不要写成 a . Function();
b->Function(); // 不要写成 b -> Function();
示例 2-3 代码行内的空格
高质量 C++/C 编程指南,v 1.0
2001 Page 18 of 101
2.4 对齐
z 【规则 2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用
它们的语句左对齐。
z 【规则 2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。
示例 2-4(a)为风格良好的对齐,示例 2-4(b)为风格不良的对齐。
void Function(int x)
{
… // program code
}
void Function(int x){
… // program code
}
if (condition)
{
… // program code
}
else
{
… // program code
}
if (condition){
… // program code
}
else {
… // program code
}
for (initialization; condition; update)
{
… // program code
}
for (initialization; condition; update){
… // program code
}
While (condition)
{
… // program code
}
while (condition){
… // program code
}
如果出现嵌套的{},则使用缩进对齐,如:
{
…
{
…
}
…
}
示例 2-4(a) 风格良好的对齐 示例 2-4(b) 风格不良的对齐
高质量 C++/C 编程指南,v 1.0
2001 Page 19 of 101
2.5 长行拆分
z 【规则 2-5-1】代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长,否
则眼睛看不过来,也不便于打印。
z 【规则 2-5-2】长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以
便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。
if ((very_longer_variable1 >= very_longer_variable12)
&& (very_longer_variable3 <= very_longer_variable14)
&& (very_longer_variable5 <= very_longer_variable16))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,
CMatrix rightMatrix);
for (very_longer_initialization;
very_longer_condition;
very_longer_update)
{
dosomething();
}
示例 2-5 长行的拆分
2.6 修饰符的位置
修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题。
若将修饰符 * 靠近数据类型,例如:int* x; 从语义上讲此写法比较直观,即 x
是 int 类型的指针。
上述写法的弊端是容易引起误解,例如:int* x, y; 此处 y 容易被误解为指针变
量。虽然将 x 和 y 分行定义可以避免误解,但并不是人人都愿意这样做。
z 【规则 2-6-1】应当将修饰符 * 和 & 紧靠变量名
例如:
char *name;
int *x, y; // 此处 y 不会被误解为指针
高质量 C++/C 编程指南,v 1.0
2001 Page 20 of 101
2.7 注释
C 语言的注释符为“/*…*/”。C++语言中,程序块的注释常采用“/*…*/”,行注释
一般采用“//…”。注释通常用于:
(1)版本、版权声明;
(2)函数接口说明;
(3)重要的代码行或段落提示。
虽然注释有助于理解代码,但注意不可过多地使用注释。参见示例 2-6。
z 【规则 2-7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,
注释太多了会让人眼花缭乱。注释的花样要少。
z 【规则 2-7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。
例如
i++; // i 加 1,多余的注释
z 【规则 2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码
的一致性。不再有用的注释要删除。
z 【规则 2-7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而
有害。
z 【规则 2-7-5】尽量避免在注释中使用缩写,特别是不常用缩写。
z 【规则 2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不
可放在下方。
z 【规则 2-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注
释,便于阅读。
示例 2-6 程序的注释
/*
* 函数介绍:
* 输入参数:
* 输出参数:
* 返回值 :
*/
void Function(float x, float y, float z)
{
…
}
if (…)
{
…
while (…)
{
…
} // end of while
…
} // end of if
剩余100页未读,继续阅读
BlockchainExplorer
- 粉丝: 65
- 资源: 10
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
最新资源
- 多模态联合稀疏表示在视频目标跟踪中的应用
- Kubernetes资源管控与Gardener开源软件实践解析
- MPI集群监控与负载平衡策略
- 自动化PHP安全漏洞检测:静态代码分析与数据流方法
- 青苔数据CEO程永:技术生态与阿里云开放创新
- 制造业转型: HyperX引领企业上云策略
- 赵维五分享:航空工业电子采购上云实战与运维策略
- 单片机控制的LED点阵显示屏设计及其实现
- 驻云科技李俊涛:AI驱动的云上服务新趋势与挑战
- 6LoWPAN物联网边界路由器:设计与实现
- 猩便利工程师仲小玉:Terraform云资源管理最佳实践与团队协作
- 类差分度改进的互信息特征选择提升文本分类性能
- VERITAS与阿里云合作的混合云转型与数据保护方案
- 云制造中的生产线仿真模型设计与虚拟化研究
- 汪洋在PostgresChina2018分享:高可用 PostgreSQL 工具与架构设计
- 2018 PostgresChina大会:阿里云时空引擎Ganos在PostgreSQL中的创新应用与多模型存储
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功