经典C编程规范完整篇PPT学习课件.ppt
《经典C编程规范完整篇PPT学习课件.ppt》由会员分享,可在线阅读,更多相关《经典C编程规范完整篇PPT学习课件.ppt(112页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、C语言编程规范语言编程规范参考华为软件编程规范主要内容C语言编程规范语言编程规范1 排版排版2 注释注释3 标识符命名标识符命名4 可读性可读性5 变量、结构变量、结构6 函数、过程函数、过程7 可测性可测性8 程序效率程序效率9 质量保证质量保证10 代码编辑、编译、审查代码编辑、编译、审查11 代码测试、维护代码测试、维护12 宏宏C语言编程规范语言编程规范1 1 排版排版C语言编程规范语言编程规范1 排版1-1:程序块要采用缩进风格编写,缩进的空格数为:程序块要采用缩进风格编写,缩进的空格数为4个。个。1-2:相对独立的程序块之间、变量说明之后必须加空行。:相对独立的程序块之间、变量说明
2、之后必须加空行。1-3:较长的语句(:较长的语句(80字符)要字符)要分成多行书写分成多行书写,长表达式要在低优先级操作符,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐排版整齐,语句可读。,语句可读。report_or_not_flag=(taskno MAX_ACT_TASK_NUMBER)&(n7stat_stat_item_valid(stat_item)&(act_task_tabletaskno.result_data!=0);C语言编程规范语言编程规范1 排版1-4
3、:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。示例:if(taskno max_act_task_number)&(n7stat_stat_item_valid(stat_item)./program codefor(i=0,j=0;(i BufferKeywordword_index.word_length)&(j),后不应加空格。),后不应加空格。说明:采用这种松散方式编写代码的目的是使代码更加清晰。由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格.如括号内侧(即左括号后面和右括号前面
4、)不需要加空格,多重括号间不必加空格,因为在C/C+语言中括号已经是最清晰的标志了。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。C语言编程规范语言编程规范1 排版(1)逗号、分号只在后面加空格。逗号、分号只在后面加空格。int a,b,c;(2)比较操作符比较操作符,赋值操作符赋值操作符=、+=,算术操作符,算术操作符+、%,逻辑操作,逻辑操作符符&、&,位域操作符,位域操作符=MAX_TIME_VALUE)a=b+c;a*=2;a=b 2;C语言编程规范语言编程规范1 排版(3)!、+、-、&(地址运算符)等(地址运算符
5、)等单目操作符单目操作符前后不加空格。前后不加空格。*p=a;/内容操作*与内容之间flag=!isEmpty;/非操作!与内容之间p=&mem;/地址操作&与内容之间i+;/+,-与内容之间(4)-、.前后不加空格。前后不加空格。p-id=pid;/-指针前后不加空格(5)if、for、while、switch等与后面的括号间应加空格,等与后面的括号间应加空格,使使if等关键字更为突出、等关键字更为突出、明显明显。if(a=b&c d)C语言编程规范语言编程规范2 2 注释注释C语言编程规范语言编程规范2 注释注释2-1:一般情况下,源程序有效注释量必须在:一般情况下,源程序有效注释量必须在
6、20以上。以上。C语言编程规范语言编程规范2 注释注释/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.File name:/文件名文件名 Author:Version:Date:/作者、版本及完成日期作者、版本及完成日期 Description:/用于详细说明此程序文件完成的主要功能,与其他模块用于详细说明此程序文件完成的主要功能,与其他模块 /或函数的接口,输出值、取值范围、含义及参数间的控或函数的接口,输出值、取值范围、含义及参数间的控 /制、顺序、独立或依赖等关系制、顺序、独立或依赖等关系 Others:/其它内容的说明其它内容的说明 Funct
7、ion List:/主要函数列表,每条记录应包括函数名及功能简要说明主要函数列表,每条记录应包括函数名及功能简要说明 1.History:/修改历史记录列表,每条修改记录应包括修改日期、修改修改历史记录列表,每条修改记录应包括修改日期、修改 /者及修改内容简述者及修改内容简述 1.Date:Author:Modification:2.*/2-2:说说明性文件明性文件(如(如头头文件文件.h文件、文件、.inc文件、文件、.def文件、文件、编译说编译说明文明文件件.cfg等)等)头头部部应应进进行注行注释释,注,注释释必必须须列出:列出:版版权说权说明明、版本号版本号、生成日期生成日期、作者作
8、者、内容内容、功能功能、与其它文件的关系与其它文件的关系、修改日志修改日志等,等,头头文文件的注件的注释释中中还应还应有有函数功能函数功能简简要要说说明明。C语言编程规范语言编程规范2 注释注释2-3:源源文文件件头头部部应应进进行行注注释释,列列出出:版版权权说说明明、版版本本号号、生生成成日日期期、作作者者、模模块目的块目的/功能、主要函数及其功能、修改日志等。功能、主要函数及其功能、修改日志等。示例:下面这段源文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。C语言编程规范语言编程规范2 注释注释说明:明:Description一一项描述本文件的描述本文件的内容、内
9、容、功能、功能、内部各部分内部各部分之之间的关系的关系及及本文本文件与其它文件关系件与其它文件关系等。等。History是是修修改改历史史记录列表列表,每条修改每条修改记录应包包括修改日期、修改括修改日期、修改者及修改内容者及修改内容简述。述。/*Copyright(C),1988-1999,Huawei Tech.Co.,Ltd.FileName:test.cpp Author:Version:Date:Description:/模块描述 Version:/版本信息 Function List:/主要函数及其功能 1.-History:/历史修改记录 David 96/10/12 1.0 b
10、uild this moudle */C语言编程规范语言编程规范2 注释注释2-4:函函数数头头部部应应进进行行注注释释,列列出出:函函数数的的目目的的/功功能能、输输入入参参数数、输输出出参参数数、返回值、调用关系(函数、表)等。返回值、调用关系(函数、表)等。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。示例:下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。/*Function:/函数名称函数名称 Description:/函数函数功能、性能功能、性能等的描述等的描述 Calls:/被本函数调用的函数清单被本函数调用的函数
11、清单 Called By:/调用本函数的函数清单调用本函数的函数清单 Table Accessed:/被访问的表(此项仅对于牵扯到数据库操作的程序)被访问的表(此项仅对于牵扯到数据库操作的程序)Table Updated:/被修改的表(此项仅对于牵扯到数据库操作的程序)被修改的表(此项仅对于牵扯到数据库操作的程序)Input:/输入参数说明,包括每个参数的作输入参数说明,包括每个参数的作 /用、取值说明及参数间关系。用、取值说明及参数间关系。Output:/对输出参数的说明。对输出参数的说明。Return:/函数返回值的说明函数返回值的说明 Others:/其它说明其它说明*/C语言编程规范语
12、言编程规范2 注释注释2-5:边边写写代代码码边边注注释释,修修改改代代码码同同时时修修改改相相应应的的注注释释,以以保保证证注注释释与与代代码码的的一一致性。不再有用的注释要删除。致性。不再有用的注释要删除。2-6:注释的内容要清楚注释的内容要清楚、明了,含义准确,防止注释二义性。、明了,含义准确,防止注释二义性。2-7:避免在注释中使用缩写避免在注释中使用缩写,特别是非常用缩写。,特别是非常用缩写。说明:在使用缩写时或之前,应对缩写进行必要的说明。2-8:注注释释应应与与其其描描述述的的代代码码相相近近,对对代代码码的的注注释释应应放放在在其其上上方方或或右右方方(对对单单条条语语句句的的
13、注注释释)相相邻邻位位置置,不不可可放放在在下下面面,如如放放于于上上方方则则需需与与其其上上面面的的代代码码用用空行隔开空行隔开。C语言编程规范语言编程规范2 注释注释2-9:对对于于所所有有有有物物理理含含义义的的变变量量、常常量量,如如果果其其命命名名不不是是充充分分自自注注释释的的,在在声声明明时时都都必必须须加加以以注注释释,说说明明其其物物理理含含义义。变变量量、常常量量、宏宏的的注释应放在其上方相邻位置或右方。注释应放在其上方相邻位置或右方。2-10:数数据据结结构构声声明明(包包括括数数组组、结结构构、类类、枚枚举举等等),如如果果其其命命名名不不是是充充分分自自注注释释的的,
14、必必须须加加以以注注释释。对对结结构构中中的的每每个个域域的的注注释释放放在在此此域域的的右方右方。C语言编程规范语言编程规范2 注释注释示例:可按如下形式示例:可按如下形式说明说明枚举枚举/数据数据/联合结构联合结构。/*sccp interface with sccp user primitive message name*/enum SCCP_USER_PRIMITIVE N_UNITDATA_IND,/*sccp notify sccp user unit data come*/N_NOTICE_IND,/*sccp notify user the No.7 network can n
15、ot*/*transmission this message*/N_UNITDATA_REQ,/*sccp users unit data transmission request*/;C语言编程规范语言编程规范2 注释注释2-11:全全局局变变量量要要有有较较详详细细的的注注释释,包包括括对对其其功功能能、取取值值范范围围、哪哪些些函函数数或或过过程程存取它以及存取时注意事项等的说明。存取它以及存取时注意事项等的说明。2-12:注释与所描述内容进行同样的缩排。:注释与所描述内容进行同样的缩排。说明:可使程序排版整齐,并方便注释的阅读与理解。示例:如下例子,排版不整齐,阅读稍感不方便。void
16、 example_fun(void)/*code one comments*/CodeBlock One /*code two comments*/CodeBlock Two 应改为如下布局。应改为如下布局。void example_fun(void)/*code one comments*/CodeBlock One /*code two comments*/CodeBlock TwoC语言编程规范语言编程规范2 注释注释2-13:将注释与其上面的代码用空行隔开。:将注释与其上面的代码用空行隔开。应如下书写应如下书写/*code one comments*/program code one/
17、*code two comments*/program code two示例:如下例子,显得代码过于紧凑。示例:如下例子,显得代码过于紧凑。/*code one comments*/program code one/*code two comments*/program code twoC语言编程规范语言编程规范2 注释注释2-14:对对变变量量的的定定义义和和分分支支语语句句(条条件件分分支支、循循环环语语句句等等)必必须须编编写写注注释释。2-15:对对于于switch语语句句下下的的case语语句句,如如果果因因为为特特殊殊情情况况需需要要处处理理完完一一个个case后后进进入入下下一一
18、个个case处处理理,必必须须在在该该case语语句句处处理理完完、下下一一个个case语语句句前前加加上上明明确确的的注注释释。说明:这样比较清楚程序编写者的意图,有效防止无故遗漏break语句。C语言编程规范语言编程规范2 注释注释2-1:避免在一行代码或表达式的中间插入注释。:避免在一行代码或表达式的中间插入注释。2-2:通过对函数或过程、变量、结构等:通过对函数或过程、变量、结构等正确的命名正确的命名以及合理地组织代码以及合理地组织代码的结构,使代码成为的结构,使代码成为自注释自注释的。的。说明:清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。2-3:在:在代码的代
19、码的功能、意图功能、意图层次上进行注释层次上进行注释,提供有用、额外的信息。,提供有用、额外的信息。C语言编程规范语言编程规范2 注释注释2-4:在程序块的结束行右方加注释标记,以表明某:在程序块的结束行右方加注释标记,以表明某程序块的结束程序块的结束。2-5:注释格式尽量统一,建议使用:注释格式尽量统一,建议使用“/*/”。2-6:注注释释应应考考虑虑程程序序易易读读及及外外观观排排版版的的因因素素,使使用用的的语语言言若若是是中中、英英兼兼有的,有的,建议多使用中文建议多使用中文,除非能用非常流利准确的英文表达。,除非能用非常流利准确的英文表达。C语言编程规范语言编程规范3 3 标识符命名
20、标识符命名C语言编程规范语言编程规范3 3 标识符命名标识符命名3-1:标标识识符符的的命命名名要要清清晰晰、明明了了,有有明明确确含含义义,同同时时使使用用完完整整的的单单词词或或大家基本可以理解的缩写,避免使人产生误解。大家基本可以理解的缩写,避免使人产生误解。3-2:命名中:命名中若使用特殊约定或缩写若使用特殊约定或缩写,则,则要有注释说明要有注释说明。说明:应该在源文件的开始之处,对文件中所使用的缩写或约定,特殊的缩写,进行必要的注释说明 3-3:自己特有的:自己特有的命名命名风格,风格,要自始至终保持一致要自始至终保持一致,不可来回变化。,不可来回变化。C语言编程规范语言编程规范3
21、3 标识符命名标识符命名3-4:对对于于变变量量命命名名,禁禁止止取取单单个个字字符符(如如i、j、k.),建建议议除除了了要要有有具具体体含含义义外外,还还能能表表明明其其变变量量类类型型、数数据据类类型型等等,但但i、j、k作作局局部部循循环环变量是允许的变量是允许的。3-5:命名命名规规范范必必须须与所使用的系与所使用的系统风统风格保持一致,并格保持一致,并在同一在同一项项目中目中统统一一.C语言编程规范语言编程规范3 3 标识符命名标识符命名3-13-1:除非必要,:除非必要,不要用数字或较奇怪的字符不要用数字或较奇怪的字符来定义标识符。来定义标识符。3-23-2:在在同同一一软软件件
22、产产品品内内,应应规规划划好好接接口口部部分分标标识识符符(变变量量、结结构构、函函数及常量)的命名,防止编译、链接时产生冲突。数及常量)的命名,防止编译、链接时产生冲突。说明:对接口部分的标识符应该有更严格限制,防止冲突。如可规定接口部分的变量与常量之前加上“模块”标识等。3-3 3-3:用:用正确的反义词组命名正确的反义词组命名具有互斥意义的变量或相反动作的具有互斥意义的变量或相反动作的函数函数等。等。C语言编程规范语言编程规范3 3 标识符命名标识符命名说明:下面是一些在软件中常用的反义词组。说明:下面是一些在软件中常用的反义词组。add/remove begin/end create/
23、destroy insert/delete first/last get/releaseincrement/decrement put/getadd/delete lock/unlock open/closemin/max old/new start/stopnext/previous source/target show/hidesend/receive source/destinationcut/paste up/down示例:示例:int min_sum;int max_sum;int add_user(BYTE*user_name);int delete_user(BYTE*user_
24、name);C语言编程规范语言编程规范3 3 标识符命名标识符命名3-4:除了编译:除了编译开关开关/头文件头文件等特殊应用,应等特殊应用,应避免使用避免使用_EXAMPLE_TEST_之类以之类以下划线下划线开始和结尾开始和结尾的定义的定义。C语言编程规范语言编程规范4 4 可读性可读性C语言编程规范语言编程规范4 4 可读性可读性4-1:注意运算符的优先级,:注意运算符的优先级,并用括号并用括号明确表达式的明确表达式的操作顺序操作顺序,避免使用默认优,避免使用默认优先级。先级。4-2:避免使用不易理解的数字避免使用不易理解的数字,用有意义的用有意义的标识标识来替代来替代。涉及物理状态或者含
25、。涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏枚举或宏来代替。来代替。4-3:源程序中关系较为紧密的代码应尽可能相邻。:源程序中关系较为紧密的代码应尽可能相邻。若按如下形式书写,可能更清晰一些。rect.length=10;rect.width=5;char_poi=str;说明:便于程序阅读和查找。示例:以下代码布局不太合理。rect.length=10;char_poi=str;rect.width=5;C语言编程规范语言编程规范4 4 可读性可读性4-4:不要使用难懂的技巧性很高的语句,除非很有必要时。:不
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 经典 编程 规范 完整 PPT 学习 课件
限制150内