2016新编2010年面向对象课程设计实习指导书v1[1][1].

1、面向对象课程设计指导书中国地质大学（武汉）信息工程学院软件工程系面向对象课程设计实习指导书使用班级：1110912 指导老师：叶亚琴 杨林2010-5-13目录一、课程设计目的3二、课程设计要求3三、课程设计题目3预备任务3实习任务17实习任务29实习任务310实习任务411实习任务512实习任务613四、成绩评定及评分标准14附件一、c+编码规范151、文件组织152、命名规则173、注释214、程序的版式245、可移植性376、提高程序的效率38附件二、课程设计报告格式39一、课程设计目的程序设计是一门实践性非常强的教学环节，学生在面向对象的程序设计课程结束后，由于课内实习时间的不足，很多

2、内容还来不及消化，特别是多态的概念。本课程设计的目的就是要通过时间相对集中的强化训练，使学生对所学理论知识进行一次综合性复习，进一步提高程序设计的能力。本课程设计的重点在于培养学生程序设计和软件开发有关的综合能力，具体包括：1、 培养学生对实际问题的分析能力； 2、 培养学生独立编程、开发软件的动手能力；3、 培养学生开放思维的创新能力；4、 培养学生熟练掌握vc+调试技能；5、 培养学生规范的编程习惯；6、 培养学生撰写课程设计报告的能力。二、课程设计要求为了能更好地达到课程设计的目的，要求学生：1、每次上机前充分做好准备工作，查阅资料，预习相关内容，对课程设计内容进行方案的预设计，编制出源

3、程序代码。2、充分利用上机时间完成源程序代码的输入、调试及优化。3、程序代码的编制应按照c+编码规范的要求进行，具体可参考指导书中【附件一】“c+编码规范”。并将规范应用到你的实际编程中去，形成良好的习惯。4、课程设计结束后，按照指导书中【附件二】“课程设计报告格式”的要求撰写出课程设计报告（要求用a4纸打印，报告格式的电子文档由指导教师提供）。预备任务任务1不需要撰写报告，但要检查程序；实习任务26要填写报告。5、按题目要求独立完成课程设计，不旷课、不迟到、不早退、遵守机房规定、爱护机房设备。三、课程设计题目预备任务1. 实习说明：该任务专门针对mfc基本框架还不熟悉的同学，若你能较快完成，

4、请直接从实习任务1开始。2. 实习内容：在visual studio2005中创建mfc基本框架，添加菜单，添加菜单处理函数，增加自己的类，复习调试技术。3. 实习目标（实习结束时请在达到的目标前打勾）：（1） 初步掌握新建（new）基本mfc项目的方法；（2） 可以添加自定义菜单；（3） 可以添加菜单的消息处理函数；（4） 能够使用afxmessagebox函数；（5） 能够添加自定义的类文件；（6） 能够掌握防止头文件重复包含的方法；（7） 能够编写基本的类；（8） 初步熟悉mfc单文档框架工程的文件组成；（9） 复习了调试技术。4. 上机指南：（1） 启动visual studio200

5、5；（2） 创建一个新的项目（包括解决方案），可命名为try1（2.1）点击“file（文件）”“new（新建）”“project（项目）”；（2.2）在“project types（项目类型）”中选“win32”；（2.3）在“templates（模版）”中选“mfc应用程序”；（2.4）在“name（名称）”框中输入 try1，然后点击“ok”；（2.5）在“应用程序类型”中，选择“单文档”；（2.6）点击“finish（完成）”。（3） 执行编译和连接，生成可执行程序（4） 执行程序，观察运行结果：（4.1）点击菜单“debugstart debugging”或按f5（4.2）点击菜单“

6、debugstart without debugging”或按ctrlf5（5） 观察项目结构（5.1）展开解决方案中的项目树，观察项目文件组成；（5.2）打开各文件，浏览文件中的基本内容；（5.3）切换到类视图和资源视图，进一步观察各内容。（6） 增加自定义菜单（6.1）在项目的资源视图中打开菜单资源；（6.2）增加一个顶层菜单“课程设计”；（6.3）在该顶层菜单下增加一个下拉菜单“msg”，观察该菜单的属性；（6.4）选中“msg”菜单，按右键，在弹出的快捷菜单中，选择“添加事件处理程序”；（6.5）在弹出的对话框类列表中，选择“ctry1view”类，确认；（6.6）在void ctry

7、1view:onmymenumsg()函数体中增加下面代码:afxmessagebox(这是我做的菜单);运行程序，点击菜单，观察效果；（6.7）分析代码，看菜单消息是如何与函数相对应的。（7） 增加自定义类以及相关文件（7.1）在“解决方案”视图中，在头文件文件夹上按右键，选择添加新项，选择头文件类型，命名为point.h；（7.2）在新增加的类中，定义一个类，实现“点”类型，要求有x,y坐标（int类型），构造函数，有set和get函数存取坐标，类中的属性必须是私有的，要求类、成员变量、成员函数命名要符合规范；头文件必须能够处理重复包含的情况，具体细节请参见附录15页。注: 下面是点类的一

8、个参考定义：（7.3）在源文件文件夹上按右键，选择添加新项，选择c+源文件类型，命名为point.cpp，在该文件中实现点类的函数等。注意在该cpp文件的第一行必须是#include stdafx.h(7.4) 添加文件后，解决方案看起来应该类似下图效果（8） 在前面定义的菜单函数中，调用设计号的点类，用对话框显示点坐标值。（注：afxmessagebox中可以是一般字符串，可以使用sprintf函数转换坐标为字符串）。该函数的参考代码如下所示：void ctry1view:onmymenumsg()point p;char coord30;sprintf(coord,x:%d,y:%d,p.

9、getx(),p.gety();afxmessagebox(coord);point就是要求编写的类。5. 实习过程中，可以进行下面的尝试：（1） 添加菜单后，改变菜单的id：（2） 在添加菜单消息映射函数的过程中，改变函数名为更加有意义的名字：（3） 在生成点对象时，使用缺省构造函数加set函数，使用带参数的构造函数；（4） 生成点对象时，使用一般对象定义方式，也可以试验new , delete的方式。（5） 复习以前的调试技术（设置断点，单步追踪，观察变量值等）。实习任务11. 实习内容（反复练习下列内容，达到实习目标）：n 锻炼编写基本类；2. 实习目标（实习结束时请在达到的目标前打勾）

10、：（1） 掌握public，private在类中的应用；（2） 掌握如何编写带参数的构造函数；（3） 掌握如何编写与调用成员函数；（4） 掌握如何在项目中添加多个自定义类以及文件等；（5） 初步体会面向对象的编程特点。3. 上机指南：（1） 启动visual studio2005；（2） 创建一个和“预备任务”同样类型的新的项目（包括解决方案），可命名为tryn；（3） 熟悉代码，复习编译、调试等菜单和快捷键；（4） 编写矩形类，要求使用上次实习的点类做为坐标的类型，需要有计算面积、计算周长，绘画自己(draw)等成员函数。draw函数目前就是弹出一个对话框，显示自己是矩形，并显示出坐标；除了

11、缺省构造函数外，添加能够直接定义矩形的带参数的构造函数；提示：带参数的构造函数可以把左上角坐标和右下角坐标做为参数，也可以左下角坐标配合长、宽做参数；矩形类必须有自己的私有成员变量保存坐标等；下面是矩形类的参考定义：其中 const point &p的用法鼓励大家课下讨论其目的，如果对该语法的使用感觉困难，可以用一般方法 “point p “ 的形式进行参数传递，但是前面一种要好一些。（5） 编写三角形类，也要求有计算面积，计算周长，绘画等成员函数以及特定的构造函数；注：可以考虑用三个定点坐标标识三角形。（6） 编写圆形类，也要求有计算面积，计算周长，绘画等成员函数以及特定的构造函数；注：可以

12、考虑用圆心、半径表示圆。（7） 编写正方形类，也要求有计算面积，计算周长，绘画等成员函数以及特定的构造函数；注：可以考虑用一个定点加上宽度标识正方形。（8） 编写图形类(graph)，每个图形对象包含有一个圆，一个矩形，一个正方形，一个三角形，图形类有得到总面积，得到总周长，绘画所有图形等功能；注：可以把图形类考虑为一张画，画里面有一个圆，一个矩形，一个正方形，一个三角形。把这几个形状做为图形类的私有成员变量，通过构造函数或者set函数设置进来，然后利用这些变量实现计算总面积、计算总周长、绘画等功能。（9） 添加一个新菜单，在菜单处理函数中创建一个具体的图形对象，调用该对象的几个方法，弹出对话

13、框显示结果：注：图形对象以及里面的圆等形状对象可以直接在程序中进行创建，设置坐标，不需要通过交互输入值。（10） 编译、运行程序，观察结果；若有错，则调试改正；实习任务21. 实习内容：（1） 改进实习1编写的程序（重写），利用纯虚基类、继承等重写函数；（2） 改进图形类，使之方便地处理多个形状对象。2. 目标要求（实习结束时请在达到的目标前打勾）：（1） 能够理解并应用继承的概念；（2） 能够正确地撰写虚函数；（3） 初步体会到多态带来的方便。3. 上机指南：（1） 以实习1为基础，针对矩形、三角形、正方形、圆形的特点，提取出一个基类（父类），编写该类的方法；（2） 考虑一个合理的名字来命名

14、新的类；（3） 分析提取出的基类的方法是否应该设置为虚函数；（4） 矩形、三角形、正方形、圆形等类需要继承基类，重写相应的虚函数；注：这里要注意得到面积、得到周长等方法应该声明为virtual函数。（5） 改写图形类，使该类中存储一个形状数组，数组数目可以在程序中用一个宏预定义，要求数组中存储的对象类型为纯虚基类的指针，重写图形类的几个成员函数，与以前的做对比，分析变化情况；（6） 注意不要产生内存泄漏。 （7） 改变数组长度宏的大小，看图形类计算总面积，计算总长度，绘画等代码是否需要改变？改变得是哪些？（8） 扩展要求（本要求不需要一定完成，完成的可以考虑适当加分）：继续改进上面的程序，把提

15、取出的基类实现为纯虚基类。如果对纯虚基类的概念不熟悉，鼓励进行快速的自学，掌握这个概念。实习任务31. 实习内容：（1） 完善实习2的内容；（2） 在实习2的基础上，更改draw函数，直接在屏幕上绘画出对象的形状。2. 目标要求（实习结束时请在达到的目标前打勾）：（1） 巩固实习2要求的目标；（2） 根据示例代码，更改实习2中的代码，实际绘画出图形：（3） 运用调试方法修改、检查和完善程序。3. 上机指南：在屏幕上绘图使用是mfc的一些类，这里不要求大家掌握很多，只要能够用就可以了，下面是绘图所需要的一些代码参考。主要先找到ondraw函数，再根据下面的参考更改程序作出绘画的效果。(注意试验用

16、的坐标不要太大，否则图形可能看不到)。void ctry1view:ondraw(cdc* pdc)ctry1doc* pdoc = getdocument();assert_valid(pdoc);if (!pdoc)return;/ 添加的画线(100,100)-(200,200)pdc-moveto(100,100);pdc-lineto(200,200);/画圆(300，300)和（400,400）确定了圆的外接正方形pdc-ellipse(300,300,400,400);上面是基本的绘画函数，可以考虑利用这些函数实现画矩形、画三角形等功能。注：万一实习3的要求实在达不到，也可以先把

17、实习2中的图形在屏幕上进行绘画，如果绘画成功，也算完成本实习任务。实习任务41. 实习内容：(1) 完善实习3的功能；(2) 增加新的方法，体验程序维护的工作。2. 目标要求（实习结束时请在达到的目标前打勾）：(1) 实习3的任务确实已经完成；(2) 增加了新的方法；(3) 初步具有到了程序不断改进的经验；3. 上机指南：（1） 在实习3程序的基础上，在每个形状上添加一个函数isselected，参数为一个点坐标，如果点在形状内部或者边界上，返回真，否则返回假；（2） 在图形对象中添加一个函数，传入一个点坐标，把选中的形状列表返回来；（3） 增加一个菜单，测试是否正确选择了对象，弹出对话框显示

18、选择结果；（4） 第3步通过后，更改ondraw中的代码，使程序只显示被选中的形状。（注：图形中的形状对象以及选择点可以直接写在程序中，不需要交互输入）。实习任务51. 实习内容：(1) 体会多个对象之间的组合；(2) 编写调试程序。2. 目标要求（实习结束时请在达到的目标前打勾）：(1) 能够编写要求的多个类；(2) 初步体会到面向对象编程所表现出的整体与部分的概念；3. 上机指南：(1) 根据汽车的结构，构造一组类，简单描述汽车；(2) 编写发动机类(engine) 有启动、停止、转动等方法；(3) 编写窗户类(window)，有摇上、摇下等方法；(4) 编写车轮类（wheel），有调整方

19、向方法，带角度参数；(5) 编写车门类(door)，有打开、关闭等方法，有窗户属性；(6) 编写一个汽车类（car），由2扇门、4个车轮、一个发动机组成，撰写一个驾驶函数，模拟开车场景，比如关上车门，摇上窗户，发动发动机，调整方向等；(7) 要求用对话框显示汽车状态。实习任务61. 实习内容：(1) 熟练文件读写功能；(2) 编写调试程序。2. 目标要求（实习结束时请在达到的目标前打勾）：(1) 能够熟练的读写文件；(2) 能够主动将功能相对独立的代码封装成函数；3. 上机指南：统计学生成绩从文本文件中读某班学生的学号、姓名和成绩，进行分析给出平均分、最高分、最低分、最大分数差、标准差、各学生

20、的名次，把结果输出到文件中。其中：最大分数差=最高分-最低分 注：该任务属于扩展任务，不需要所有的同学完成。完成者可加分。四、成绩评定及评分标准由指导教师根据课程设计任务完成情况、现场提问、观看运行结果、评阅课程设计报告并参考学生平时表现等五方面给出课程设计成绩。1、具体评分标准（见表5-1），成绩等级分为：a（100分）、b（80分）、c（70分）、d（60分）、e（60分）五档或折合成百分制给出成绩。表5-1 vc+课程设计评分暂行标准项目评定内容评分标准（abcde）评分ad课堂检查完成设计题目的数量与质量（x1）超额完成设计题目，达到较高的程序设计水平，具有一定的创新性、实用性。基本完

21、成课程设计要求提问检查基础理论掌握情况（x2）回答问题准确合理，概念表达清楚、有条理。基本符合问题要求调试能力和软件运行检查（x3）具有较强的调试程序的能力，操作熟练，程序运行结果正确，界面友好，界面结构合理。程序运行结果基本符合要求课程设计报告课程设计报告情况检查（x4）严格按照课程设计报告格式的要求，设计文档规范；书写清晰有条理，图文并貌，能够总结算法或设计的优缺点，附有改进意见、设计体会或心得。基本达到课程设计报告的要求平时表现出勤记载（x5）严格遵守机房规定，不迟到不早退，不做与课程设计无关的事情基本能按要求进行课程设计总分总分（x1 +x2 +x3 +x4 +x5）/52、指导老师按

22、优秀、良好、中等、及格、不及格五档提交成绩，成绩等级如下：优 秀：90-100；良 好：80-89；中 等：70-79；及 格：60-69；不及格：60，成绩不合格者需要重修。附件一、c+编码规范1、文件组织（1） 文件结构a、版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见例1），主要内容有： 版权信息。 文件名称，标识符，摘要。 当前版本号，作者/修改者，完成日期。 版本历史信息。/copyright (c) 2002-2005, 中国地质大学/ all rights reserved./ / 文件名称：输入文件名，如filename.h/ 文件标识：见配置管理计划书/ 摘

23、 要：简要描述本文件的内容/ / 当前版本：1.1/ 作 者：输入作者（或修改者）名字/ 完成日期：2002年7月20日/ 取代版本：1.0 / 原作者 ：输入原作者（或修改者）名字/ 完成日期：2002年5月10日例1 版权和版本的声明b、头文件的结构头文件由三部分内容组成： 头文件开头处的版权和版本声明（参见例1）。 预处理块。 函数和类结构声明等。假设定义文件的名称为 box.h，定义文件的结构参见例2。/ 版权和版本声明见例1，此处省略。#include “graphics.h”/ 引用头文件/ 全局函数的声明void function1();/ 类的声明class cbox publ

24、ic: long getsize(); private: long m_lwidth; .;例2 c+/c定义文件的结构【规则1】防止头文件内容被重复包含为了防止头文件内容被重复包含，所有头文件必须用ifndef/define/endif结构产生预处理块。例如：对于文件mystring.h，其文件内容应按照如下方式编写（例3）：#ifndef mystring_h #define mystring_h #include / 引用标准库的头文件#include “myheader.h” / 引用非标准库的头文件void function1();/ 全局函数声明class box / 类结构声明;

25、 #endif例3 文件的内容定义【规则2】引用信息顺序标准的头文件要放在前面，而且按照字母顺序排列。标准头文件和自己的头文件之间应该用空行分隔。【规则3】用 #include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。【规则4】用 #include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。【建议1】头文件中只存放“声明”而不存放“定义”在c+语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数，如果从提高性能角度考虑是可取。除此之外的选择，建议将成员函数的定义与声明分开，不论该函数体有多么小。【建议2】不提倡使用全

26、局变量，尽量不要在头文件中出现象extern int value 这类声明。c、头文件的作用 通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的，编译器会从库中提取相应的代码。 头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。（2）目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如，可将头文件保存于i

27、nclude目录，将定义文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。【规则5】统一目录结构项目开始时，规定好项目相关文件在磁盘上的存储目录结构。2、命名规则比较著名的命名规则当推microsoft公司的“匈牙利”法，该命名规则的主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。例如所有的字符变量均以ch为前缀，若是指针变量则追加前缀p，如果一个变量由ppch开头，则表明它是指向字符指针的指针。在程序体中应基本遵循匈牙利命名规则。（1） 总

28、则【规则6】标识符应当直观且可以拼读，可望文知意，不必进行“解码”。标识符应该采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名。【规则7】标识符长度应当尽量符合“min-length & max-information”原则。单字符的名字也是有用的，常见如i，j，k，m，n，x，y，z等，它们通常可用作函数内的局部变量。【规则8】程序中不要出现仅靠大小写区分的相似的标识符。例如：int x, x;/ 变量x 与 x 容易混淆void foo(int x);/ 函数foo 与foo容易混淆void foo(float x);【规则9】命名规则尽量与所采用的操作系统或开发工具的风格保持

29、一致。例如windows应用程序的标识符通常采用“大小写”混排的方式，如addchild。而unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child。别把这两类风格混在一起用。【建议3】尽量避免名字中出现数字编号，如var1，var2等，除非逻辑上的确需要编号。【建议4】尽量使用公认的无异义的缩写，缩写一般不超过4个字母。例如：html hypertext markup languageurl uniform resource locatorcmd command init initialize【规则10】程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不

30、同而不会发生语法错误，但会使人误解。【规则11】变量的名字应当使用“名词”或者“形容词名词”。例如： float value;float oldvalue;float newvalue;【规则12】函数的名字应当使用“动词”或者“动词名词”（动宾词组）。类的成员函数省掉表示对象本身的“名词”。例如：drawbox(); / 全局函数 box-draw();/ 类的成员函数【规则13】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。例如：intminvalue;intmaxvalue;intsetvalue();intgetvalue();（2） 文件【规则14】通用文件命名规则 类的

31、声明文件（.h）和实现文件（.cpp）：类名.h类名.cpp 常量定义文件：项目名称缩写（大写）+_const.h例：di_const.h 全局变量、函数声明文件：项目名称缩写（大写）+_globaldef.h例：di_globaldef.h 错误代码定义文件：项目名称缩写（大写）+_errordef.h例：di_errordef.h（3） 变量【规则15】变量名由范围前缀+类型前缀+限定词组成。【规则16】变量和参数用小写字母开头的单词组合而成。例如：bool flag;int drawmode;【规则17】变量的范围前缀 全局变量加上g_（表示global）例如：int g_howmany

32、people;/ 全局变量int g_howmuchmoney;/ 全局变量 静态变量加上s_例如：void init()static int s_initvalue;/ 静态变量 局部变量范围前缀为空【规则18】变量的类型前缀类型名称表示符号范例整型nm_ntotalnum长整型lg_lopendate无符号整型uumsgid无符号长整型dwdwcardno字符chchchar布尔量bm_bok浮点数fm_fprice双精度浮dg_drate字符数组szm_szpath指针ppprogress字节指针pbm_pbsenddata无符号指针pvg_pvparam字符指针lpszlpszname

33、str整型指针lpnlpnsysdoomtype文件指针fpm_fpfile结构体ststmystruct【规则19】方法参数名使用有意义的参数命名，如果可能的话，使用和要赋值的字段一样的名字。例如：void settopic (string strtopic) this.strtopic = strtopic; .【建议5】循环变量可以用i，j，k做循环变量，用p，q做位移变量。【规则20】常量名全用大写，用下划线分割单词例如：const int max = 100;const int max_length = 100;（4） 自定义类型【规则21】类名必须由大写字母开头的单词或缩写组成，只

34、用英文字母，禁用数字、下划线等符号。【规则22】typedef定义的类型利用typedef创建类型名为以“s”加单词或缩写组成，只用英文字母。【规则23】枚举类型枚举类型名以“e”加单词或缩写组成，只用英文字母。枚举类型的成员遵循常量命名约定，使用大写字母和下划线，名称要有含义。【规则24】结构（struct）和联合（union） 结构（struct）和联合（union）名同类名。（5） 函数【规则25】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。【规则26】函数的名字应当使用“动词”或者“动词名词”（动宾词组）。【规则27】类方法名必须用一个小写字母的动词开头，后面的单词用大写

35、字母。例如：getname()，sethtml()【建议6】方法名前缀根据需要使用get/set存取属性值，is/has/should存取布尔值。推荐使用下列方法前缀，按下列组合配对使用：add/remove，create/destroy，old/new，insert/delete，increment/decrement，start/stop，begin/end，first/last，up/down，next/previous，min/max，open/close，show/hide3、注释（1） 总则【规则28】程序可以有两种注释：代码注释（implementation comments）和

36、文档注释（documentation comments）。代码注释主要删除注释（注释掉目前不需要的代码）和说明注释（对代码进行说明），文档注释是指专门用来形成文档用的注释。【规则29】注释是why而不是what。程序中的注释不可喧宾夺主，注释的花样要少。【规则30】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。【规则31】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。【规则32】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。【规则33】修正bug之后，要加上描述修改状况的注释。（2） 文档注释【

37、规则34】文档注释文档注释用/*/标识，它对代码的使用说明进行描述，每一个文档注释被放进/*/分隔符，每一个类、接口、构造函数，方法和成员变量拥有一个注释，这样的注释应该出现在相应的声明前。 例如： /* * example类提供如下的功能 . */ class example 类和接口的文档注释（/*）的第一行不应该缩进，以后的文档注释每行都应有一个空格的缩进（给垂直排列的星号）。成员函数（包括构造函数），第一行文档注释前有一个tab缩进，后续的行有一个tab外加一个空格的缩进。对于那些不适于文档注释的类、接口、变量、方法的信息，用代码注释进行说明，而不应该在类的文档注释中。 文档注释不应该

38、放在方法或构造函数的定义体内。（3） 源程序文件【规则35】源程序文件文档注释每个源程序文件的开头都需要文档注释（参见例1），主要内容有： 版权声明：版权声明内容为copyright beijing china tech international software, inc. all rights reserved.。 文件名称：本文件的名称。 开发者姓名：填写最初编写此代码的人。 创建日期：本文件的创建日期。 功能目的：简要描述本文件中代码的功能。 修改历史（修改日期、修改人、修改编号、修改内容）。其中修改历史可以多次出现，任何对本文件的修改必须增加一条修改历史。（4）类【规则36】类注释

39、每个类的必须有文档注释，其中至少要包括：功能、版本、最后修改时间、作者、修改历史（修改日期、修改人、修改编号、修改内容）等，其中修改历史可以多次出现，任何对本类的修改必须增加一条修改历史，此外可以根据需要添加其它相关信息或链接。类注释必须在类的声明之前。 例 例如：/* 类 string 封装了有关字符串的操作，这些操作包括* 单个字符定位、串比较、查找、提取子串、大写/小写转换等* * author lee boynton * author arthur van hoff * version 1.130, 02/09/01 */class string（5） 函数【规则37】函数注释所有函数

40、（包括类自定义类型的成员函数）必须有文档注释。注释在其定义之前，按如下方式书写：/* * 判断一字符串是否为数字 * * param snum 字符串 * return true=是数字 false=不是数字 */boolean isnumber(string snum) .【规则38】构造函数注释要标明此函数为构造函数。如果有多个构造函数，用递增的方式书写，参数多的写在后面，如有多组构造函数，每组分别用递增的方式写，并且每一个都要有详细的注释。（6） 变量【规则39】变量的注释变量注释出现在变量声明或自定义数据类型成员声明的前一行，用以描述对应变量的作用和含义，变量注释一般占一行。下列变量必

41、须有注释： 自定义类型的成员 全局变量 其它重要的局部变量注释必须按如下方式书写：/* 包计数器 */int ipackets;（7） 语句【建议7】代码注释风格代码注释用/*.*/和/标识。程序可以有四种风格的代码注释：块注释、单行注释、后缘注释（trailing）、行尾注释（end-of-line）。块注释。块注释常用来提供文件、方法、数据结构、算法的说明。块注释可以被用在每个文件的开头和每个方法的起始，它们也可以被用在其他地方，比如在方法内部等。块注释在函数或方法的内部应该和它们描述的代码具有同样的缩进格式。块注释之前应该有一个空行。单行注释。短的注释可以出现在单行，和它后面的代码使用同

42、样的缩进。单行注释前应该有一个空行。后缘注释（trailing）和行尾注释（end-of-line）。非常短的注释可以出现在和它说明的代码的同一行中，但应该和被说明的代码相隔足够远。如果在一个代码块中出现了多于一个的短注释，它们应该有相同的缩进。【规则40】语句块结束注释 函数定义的结束必须加如下内容的注释： /end of 函数名。若程序文件中能够明确指出函数结束的不需加此注释。 对于包含代码行较多的条件语句，每个条件处理语句块的结束必须加如下内容的注释：/end of 此语句块的条件。 对于包含代码行较多的循环语句，循环语句块的结束必须如下内容的注释：/end of 循环条件。4、程序的版

43、式（1） 空白符a、空行【规则41】在每个类声明之后、每个函数定义结束之后都要加空行。【规则42】在一个函数体内，逻辑上密切相关的语句之间不加空行，其它地方应加空行分隔。 b、空格【规则43】在if、for、while等关键字之后应留一个空格再跟左括号(，以突出关键字。【规则44】函数名之后不要留空格，紧跟左括号(，以与关键字区别。【规则45】,、;向前紧跟，紧跟处不留空格。【规则46】,之后要留空格，如function(x, y, z)。如果;不是一行的结束符号，其后要留空格，如for (initialization; condition; update)。【规则47】赋值操作符、比较操作符

44、、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“=”、“=”、“+”、“*”、“%”、“&”、“|”、“”前后不加空格。c、对齐【规则50】相互匹配的和应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则51】 之内的代码块在新行右边一个tab处左对齐。（2）表达式a、运算符的优先级【建议8】建议对于除+，*等优先级非常明显的运算符之外，全部使用括号确定表达式的操作顺序。b、复合表达式【规则52】不要有多用途的复合表达式。c、逻辑表达式u 布尔变量与零值比较【规则53】布尔变量与零值比较不可将布尔变量直接与true、false或者1、0进行比较。应写为：bool bflag;

45、if (bflag) / 表示flag为真if (!bflag) / 表示flag为假其它的用法都属于不良风格，例如：if (flag = true)if (flag = 1 )if (flag = false) if (flag = 0)u 整型变量与零值比较【规则54】应当将整型变量用“=”或“！=”直接与0比较。假设整型变量的名字为value，它与零值比较的标准if语句如下：if (value = 0) if (value != 0)不可模仿布尔变量的风格而写成：if (value)/ 会让人误解 value是布尔变量if (!value) u 浮点变量与零值比较【规则55】不可将浮点变

46、量用“=”或“！=”与任何数字比较。千万要留意，无论是float还是double类型的变量，都有精度限制。所以一定要避免将浮点变量用“=”或“！=”与数字比较，应该设法转化成“=”或“=-epsinon) & (x=epsinon)其中epsinon是允许的误差（即精度）。u 指针变量与零值比较【规则56】应当将指针变量用“=”或“！=”与null比较，而不应采用if(p)或者if(!p)的形式。指针变量的零值是“空”（记为null）。尽管null的值与0相同，但是两者意义不同。假设指针变量的名字为p，它与零值比较的标准if语句如下：if (p = null)/ p与null显式比较，强调p是

47、指针变量if (p != null)不要写成if (p = 0) / 容易让人误解p是整型变量if (p != 0) 或者if (p)/ 容易让人误解p是布尔变量if (!p)（3）基本语句a、代码行【规则57】一行代码只做一件事情，如只定义一个重要变量，或只写一条语句。【规则58】if、for、while、do等语句自占一行，执行语句不得在同一行上。不论执行语句有多少都要加。【规则59】尽可能在定义变量的同时初始化该变量（就近原则）。【建议9】在使用之前才定义变量。【建议10】不提倡使用全局变量不提倡使用全局变量，尽量不要在头文件中出现象extern int value 这类声明。【建议11

48、】调试信息不要用cout到处打印调试信息，统一使用带开关的调试类打印调试信息。b、长行拆分【规则60】代码行最大长度为80个字符。【规则61】超长的语句应该在一个逗号后，或者一个操作符前折行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。c、修饰符的位置【规则62】应当将修饰符 * 和 紧靠变量名。（4）条件语句【建议12】程序中有时会遇到if/else/return的组合，建议将如下风格的程序：if (condition) return x; return y; 改写为 if (condition) return x;elsereturn y;或者

49、改写成更加简练的 return (condition ? x : y);【规则63】switch语句中必须有default分支。例如：switch (i) case 1:;break;case 2:;break;default :break; 【规则64】每个case语句的结尾不要忘了加break，否则将导致多个分支重叠（除非有意使多个分支重叠）。（5）循环语句【规则65】在多重循环中，如果有可能，应当将最长的循环放在最内层，最短的循环放在最外层，以减少cpu跨切循环层的次数。如：下面例4(b)的效率比例4(a)的高。for (row=0; row100; row+)for ( col=0;

50、col5; col+ )sum = sum + arowcol;for (col=0; col5; col+ )for (row=0; row100; row+) sum = sum + arowcol;例4 (a) 低效率：长循环在最外层 例4 (b) 高效率： 长循环在最内层【规则66】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。如：例5(a)的程序比例5(b)多执行了n-1次逻辑判断。并且由于前者老要进行逻辑判断，打断了循环“流水线”作业，使得编译器不能对循环进行优化处理，降低了效率。如果n非常大，最好采用例5(b)的写法，可以提高效率。如果n非常小，两者效

51、率差别并不明显，采用例5(a)的写法比较好，因为程序更加简洁。for (i=0; in; i+)if (condition) dosomething();else dootherthing();if (condition)for (i=0; in; i+) dosomething();else for (i=0; in; i+) dootherthing(); 例5(a) 效率低但程序简洁 例5(b) 效率高但程序不简洁【规则67】不可在for 循环体内修改循环变量，防止for 循环失去控制。【建议13】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。如：例6(a)中x值属于半开半闭区间“0 = x n”，起点到终点的间隔为n，循环次数为n。例6(b)中的x值属于闭区间“0 = x = n-1”，起点到终点的间隔为n-1，循环次数为n。相比之下，例6(a)的写法更加直观，尽管两者的功能是相同的。for (int x=0; xn; x+)for (int x=0; x=n-1; x+)例6(a) 循环变量属于半开半闭区间 例6(b) 循环变量属于闭区间（6）常量【规则68】静态变量使用时使用类名:变量名的方法来调用。【规则69】尽量使用含义直观的常量来表示那些将在程序中多次出现的数字或字符串。【规则70】