C语言编程培训教程资料.ppt
《C语言编程培训教程资料.ppt》由会员分享,可在线阅读,更多相关《C语言编程培训教程资料.ppt(36页珍藏版)》请在课桌文档上搜索。
1、C语言 编程培训,目录,1.排版2.注释3.标识符命名4.可读性5.变量、结构6.函数、过程7.可测性8.程序效率9.质量保证10.代码编辑、编译、审查11.代码测试、维护,1.排版,程序块要采用缩进风格编写,缩进的空格数为4个。说明:对于由开发工具自动生成的代码可以有不一致。相对独立的程序块之间、变量说明之后必须加空行。if(!a)./codeVal_1=Val_2;Val_3=Val_4;较长的语句(80字符或超过编辑器可视范围)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。perm_count_msg.hea
2、d.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(_UL);,加入空格,1.排版,循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。if(Val_aaaaaaaaa Val_bbbbbbbbb),x,1.排版,程序块的分界符(如C/C+语言的大括号 和)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。for(.
3、)./program code在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如)和一元操作符后不应加空格。int Val_a,Val_b,Val_c;Val_a=1;Val_b=Val_a+2;Val_c=!Val_b;p-Id=Pidif、for、while、switch 等与后面的括号间应加空格,使 if 等关键字更为突出、明显。if(Val_a=Val_b),x,1.排版,结构型的数组、多维的数组如果在定义时初始化,按照数组的矩阵结构分行书写。int aiNumbers43=1,1,1,2,4,8,
4、3,9,27,4,16,64相关的赋值语句等号对齐。tPDBRes.wHead=0;tPDBRes.wTail=wMaxNumOfPDB-1;tPDBRes.wFree=wMaxNumOfPDB;tPDBRes.wAddress=wPDBAddr;tPDBRes.wSize=wPDBSize;,2.注释,一般情况下,源程序有效注释量必须在20以上。源文件及说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:版权说明、版本号、生成日期、作者、内容/模块/主要函数、功能、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
5、/*Copyright:/版权说明File name:/文件名Author:Version:Date:/作者、版本及完成日期Description:/用于详细说明此程序(模块)的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系Others:/其它内容的说明Function List:/主要函数列表,每条记录应包括函数名及功能简要说明1.History:/修改历史记录列表 1.Date:/修改日期 Author:/修改者 Modification:/修改内容简述2.*/,2.注释,程序中的定义,申明和实现,应该按照类别分开,并按如下顺序注释。/*Ty
6、pes 类型定义*/*Manifest Constants 常量*/*Variables 全局变量*/*Function prototypes 函数原型*/注释符与注释内容之间要用一个空格进行分隔。/*注释内容*/,2.注释,函数头部应进行注释,列出:函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。/*Function:/函数名称Description:/函数功能、性能等的描述Calls:/被本函数调用的函数清单Called By:/调用本函数的函数清单Input:/输入参数说明,包括每个参数的作用、取值说明及参数间关系。Output:/对输出参数的说明。Return:/
7、函数返回值的说明Others:/其它说明*/边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。注释的内容要清楚、明了,含义准确,防止注释二义性。注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开/*notes on Val_a*/Val_a=1;,x,2.注释,对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。/*notes on Def_a*/#define Def_
8、a 100/*notes on Def_a*/数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。/*notes*/typedef struct char Val_a/*notes on Val_a*/Struct_a;,2.注释,全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。/*function*/变量作用、含义/*0 xxx,1 xxx*/变量取值范围/*Call by Function*/那些函数或过程调用它/*A
9、ttention*/注意事项/*How to use Val_a*/使用方法char Val_a;注释与所描述内容进行同样的缩排。/*How to use Val_a*/使用方法 char Val_a;将注释与其上面的代码用空行隔开。对变量的定义和分支语句(条件分支、循环语句等)必须编写注释。char Val_a;/*notes on Val_a*/if(.)Fuc_a();/*notes on Fuc_a*/,x,2.注释,对于switch语句下的case语句,如果因为特殊情况需要处理完一个case后进入下一个case处理,必须在该case语句处理完、下一个case语句前加上明确的注释。ca
10、se 0:if(.)break;else Fuc_a();/*now jump to case 1*/case 1:Val_a=Val_b+1;break;避免在一行代码或表达式的中间插入注释。在代码的功能、意图层次上进行注释,以提供有用、额外的信息,无需做意义不大的注释,2.注释,当代码段较长,特别是多重嵌套时,在程序块的结束行右方加注释标记,以表明某程序块的结束。if(.)./*end of if()*/指明是哪个if语句的结束注释格式尽量统一,建议使用“/*/”注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。,3.标识符命名
11、,标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。temp 可缩写为 tmp;flag 可缩写为 flg;increment 可缩写为 inc;message 可缩写为 msg;命名中若使用特殊约定或缩写,则要有注释说明。对于变量命名,禁止取单个字符(如i、j、k.),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。int liv_hight;其变量名解释如下:l局部变量(Local)i整型(in
12、terger)v变量(variable)hight变量含义命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,即大小写,下划线之类的统一。除非必要,不要用数字或较奇怪的字符来定义标识符。,3.标识符命名,用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。add/remove begin/end create/destroyinsert/delete first/last get/releaseincrement/decrement put/getadd/delete lock/unlock open/closemin/max old/new start/stopnext/pre
13、vious source/target show/hidesend/receive source/destinationcut/paste up/down除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义,4 可读性,注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。下列语句中的表达式word=(high 8)|low(1)if(a|b),4 可读性,源程序中关系较为紧密的代码应尽可能相邻。Val_a0=1;Val_b=2;Val_a1=3;不要使用难懂的技巧性很高的语句,除非很有必要时。Val_a+=1;应修改为Val_a+
14、=1;Val_a+;一条语句只完成一个功能。Val_a=Val_b+GetValue(/一条语句实现多个功能,Val_b有两种用途。,x,x,x,5 变量、结构,去掉没必要的公共变量,公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要还应说明与其它变量的关系。明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。System_Init Input_Rec Print_Rec Stat_Score Student创
15、建 修改 访问修改 Score创建修改访问访问,修改当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。防止局部变量与公共变量同名。严禁使用未经初始化的变量作为右值。特别是在 C/C+中引用未经赋值的指针,经常会引起系统崩溃。构造仅有一个模块或函数可以修改、创建,而其余有关模块或函数只访问的公共变量,防止多个不同模块或函数都可以修改、创建同一公共变量的现象。,5 变量、结构,结构的功能要单一,是针对一种事务的抽象。typedef struct STUDENT_STRU unsigned char name8;/*students name*/unsigned char ag
16、e;/*students age*/unsigned char teacher_name8;/*teachers name*/unisgned char teacher_age;/*teachers age*/STUDENT;若改为如下,可能更合理些。typedef struct STUDENT_STRU unsigned char name8;/*students name*/unsigned char age;/*students age*/STUDENT;typedef struct TEACHER_STRU unsigned char teacher_name8;/*teachers
17、name*/unisgned char teacher_age;/*teachers age*/TEACHER;不要设计面面俱到、非常灵活的数据结构。不同结构间的关系不要过于复杂。两个结构都是描述同一事物的,那么不如合成一个结构。,5 变量、结构,结构的设计要尽量考虑向前兼容和以后的版本升级,并为某些未来可能的应用保留余地。软件向前兼容的特性,是软件产品是否成功的重要标志之一。如果要想使产品具有较好的前向兼容,那么在产品设计之初就应为以后版本升级保留一定余地,并且在产品升级时必须考虑前一版本的各种特性。留心具体语言及编译器处理不同数据类型的原则及有关细节。如在 C 语言中,static 局部变
18、量将在内存“数据区”中生成,而非 static 局部变量将在“堆栈”中生成。这些细节对程序质量的保证非常重要。编程时,要注意数据类型的强制转换。对编译系统默认的数据类型转换,也要有充分的认识。如下赋值,多数编译器(IAR)不产生告警,但值的含义还是稍有变化char chr;unsigned short int exam;chr=-1;exam=chr;/编译器不产生告警,此时 exam 为 255(0 xFF)。尽量减少没有必要的数据类型默认转换与强制转换。合理地设计数据并使用自定义数据类型,避免数据间进行不必要的类型转换。对自定义数据类型进行恰当命名,使它成为自描述性的,以提高代码可读性。注
19、意其命名方式在同一产品中的统一,如IAR中 u8 定义为 unsigned short int。,5 变量、结构,不可将布尔变量和逻辑表达式直接与TRUE、FALSE或者1、0进行比较。if(bFlag=TRUE)在条件判断语句中,当整型变量与0 比较时,不可模仿布尔变量的风格,应当将整型变量用“=”或“!=”直接与0比较。if(Val_a=0)if(Val_a)不可将浮点变量用“=”或“!=”与任何数字比较。if(Val_a=0.0)应当将指针变量用“=”或“!=”与NULL比较。if(pHead=NULL)不可在for 循环体内修改循环变量,防止for 循环失去控制。且建议循环嵌套次数不大
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 语言 编程 培训 教程 资料
![提示](https://www.desk33.com/images/bang_tan.gif)
链接地址:https://www.desk33.com/p-241831.html