C语言编程规范总则.docx
- 文档编号:28570554
- 上传时间:2023-07-19
- 格式:DOCX
- 页数:47
- 大小:53.84KB
C语言编程规范总则.docx
《C语言编程规范总则.docx》由会员分享,可在线阅读,更多相关《C语言编程规范总则.docx(47页珍藏版)》请在冰豆网上搜索。
C语言编程规范总则
编程规范总则
编程规范总则1
1排版1
2注释3
3标识符命名7
4可读性9
5变量、结构10
6函数、过程14
7程序效率19
8质量保证23
9代码编辑、编译、审查28
10代码测试、维护29
11宏30
1排版
1-1:
程序块要采用缩进风格编写,缩进的空格数为4个。
说明:
对于由开发工具自动生成的代码可以有不一致。
1-2:
相对独立的程序块之间、变量说明之后必须加空行。
示例:
如下例子不符合规范。
if(!
valid_ni(ni))
{
...//programcode
}
repssn_ind=ssn_data[index].repssn_index;
repssn_ni=ssn_data[index].ni;
应如下书写
if(!
valid_ni(ni))
{
...//programcode
}
repssn_ind=ssn_data[index].repssn_index;
repssn_ni=ssn_data[index].ni;
1-3:
较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
示例:
perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN
+STAT_SIZE_PER_FRAM*sizeof(_UL);
act_task_table[frame_id*STAT_TASK_CHECK_NUMBER+index].occupied
=stat_poi[index].occupied;
act_task_table[taskno].duration_true_or_false
=SYS_get_sccp_statistic_state(stat_item);
report_or_not_flag=((taskno &&(n7stat_stat_item_valid(stat_item)) &&(act_task_table[taskno].result_data! =0)); 1-4: 不允许把多个短语句写在一行中,即一行只写一条语句。 示例: 如下例子不符合规范。 rect.length=0;rect.width=0; 应如下书写rect.length=0;rect.width=0; 1-5: if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while 等语句的执行语句部分无论多少都要加括号{}。 示例: 如下例子不符合规范。 if(pUserCR==NULL)return; 应如下书写: if(pUserCR==NULL) { return; } 1-6: 对齐只使用空格键,不使用TAB键。 说明: 以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐,不要使用BC作为编辑器合版本,因为BC会自动将8个空格变为一个TAB键,因此使用BC合入的版本大多会将缩进变乱。 1-7: 函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格,case 语句下的情况处理语句也要遵从语句缩进要求。 1-8: 程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。 在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 示例: 如下例子不符合规范。 for(...){ ...//programcode } if(...) { ...//programcode } voidexample_fun(void) { ...//programcode } 应如下书写。 for(...) { ...//programcode } if(...) { ...//programcode } voidexample_fun(void) { ...//programcode } 1-9: 一行程序以小于80字符为宜,不要写得过长。 2注释 2-1: 一般情况下,源程序有效注释量必须在20%以上。 说明: 注释的原则是有助于对程序的阅读理解,在该加的地方都加了,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。 2-2: 文件头部应进行注释,注释必须列出: 版权说明、版本号、生成日期、作者、内容、功能、修改日志等。 示例: 下面这段头文件的头注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /*****************************************************************************Copyright: 1988-1999,HuaweiTech.Co.,Ltd. Filename: 文件名 Description: 用于详细说明此程序文件完成的主要功能,与其他模块或函数的接口,输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系 Author: 作者Version: 版本Date: 完成日期 History: 修改历史记录列表,每条修改记录应包括修改日期、修改 者及修改内容简述。 *****************************************************************************/ 2-3: 函数头部应进行注释,列出: 函数的目的/功能、输入参数、输出参数、返回值、调用关系(函数、表)等。 示例: 下面这段函数的注释比较标准,当然,并不局限于此格式,但上述信息建议要包含在内。 /*************************************************Function: //函数名称 Description: //函数功能、性能等的描述Calls: //被本函数调用的函数清单CalledBy: //调用本函数的函数清单 TableAccessed: //被访问的表(此项仅对于牵扯到数据库操作的程序)TableUpdated: //被修改的表(此项仅对于牵扯到数据库操作的程序)Input: //输入参数说明,包括每个参数的作 //用、取值说明及参数间关系。 Output: //对输出参数的说明。 Return: //函数返回值的说明Others: //其它说明 *************************************************/ 2-4: 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。 不再有用的注释要删除。 2-5: 注释的内容要清楚、明了,含义准确,防止注释二义性。 说明: 错误的注释不但无益反而有害。 2-6: 注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。 示例: 如下例子不符合规范。 例1: /*getreplicatesubsystemindexandnetindicator*/ repssn_ind=ssn_data[index].repssn_index; repssn_ni=ssn_data[index].ni; 例2: repssn_ind=ssn_data[index].repssn_index; repssn_ni=ssn_data[index].ni; /*getreplicatesubsystemindexandnetindicator*/ 应如下书写 /*getreplicatesubsystemindexandnetindicator*/repssn_ind=ssn_data[index].repssn_index;repssn_ni=ssn_data[index].ni; 2-7: 对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。 变量、常量、宏的注释应放在其上方相邻位置或右方。 示例: /*activestatistictasknumber*/ #defineMAX_ACT_TASK_NUMBER1000 #defineMAX_ACT_TASK_NUMBER1000/*activestatistictasknumber*/ 2-8: 数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。 对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。 示例: 可按如下形式说明枚举/数据/联合结构。 /*sccpinterfacewithsccpuserprimitivemessagename*/ enumSCCP_USER_PRIMITIVE { N_UNITDATA_IND,/*sccpnotifysccpuserunitdatacome*/N_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannot*/ /*transmissionthismessage*/N_UNITDATA_REQ,/*sccpuser'sunitdatatransmissionrequest*/ }; 2-9: 全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及 存取时注意事项等的说明。 示例: /*TheErrorCodewhenSCCPtranslate*/ /*GlobalTitlefailure,asfollows*///变量作用、含义 /*0-SUCCESS1-GTTableerror*/ /*2-GTerrorOthers-nouse*///变量取值范围 /*onlyfunctionSCCPTranslate()in*/ /*thismodualcanmodifyit,andother*/ /*modulecanvisititthroughcall*/ /*thefunctionGetGTTransErrorCode()*///使用方法 BYTEg_GTTranErrorCode; 2-10: 注释与所描述内容进行同样的缩排。 说明: 可使程序排版整齐,并方便注释的阅读与理解。 示例: 如下例子,排版不整齐,阅读稍感不方便。 voidexample_fun(void) { /*codeonecomments*/CodeBlockOne /*codetwocomments*/CodeBlockTwo } 应改为如下布局。 voidexample_fun(void) { /*codeonecomments*/CodeBlockOne /*codetwocomments*/CodeBlockTwo } 2-11: 避免在一行代码或表达式的中间插入注释。 说明: 除非必要,不应在代码或表达中间插入注释,否则容易使代码可理解性变差。 2-12: 通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构,使代码成为自注释的。 说明: 清晰准确的函数、变量等的命名,可增加代码可读性,并减少不必要的注释。 2-13: 在代码的功能、意图层次上进行注释,提供有用、额外的信息。 说明: 注释的目的是解释代码的目的、功能和采用的方法,提供代码以外的信息,帮助读者理解代码,防止没必要的重复注释信息。 示例: 如下注释意义不大。 /*ifreceive_flagisTRUE*/if(receive_flag)而如下的注释则给出了额外有用的信息。 /*ifmtpreceiveamessagefromlinks*/ if(receive_flag) 2-14: 在程序块的结束行右方加注释标记,以表明某程序块的结束。 说明: 当代码段较长,特别是多重嵌套时,这样做可以使代码更清晰,更便于阅读。 示例: 参见如下例子。 if(...) { //programcode while(index { //programcode }/*endofwhile(index }/*endofif(...)*///指明是哪条if语句结束 2-15: 注释格式尽量统一,建议使用“/*⋯⋯*/”。 2-16: 注释应考虑程序易读及外观排版的因素,使用的语言若是中、英兼有的,建议多使用中文,除非能用非常流利准确的英文表达。 说明: 注释语言不统一,影响程序易读性和外观排版,出于对维护人员的考虑,建议使用中文。 3标识符命名 3-1: 标识符的命名要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写,避免使人产生误解。 说明: 较短的单词可通过去掉“元音”形成缩写;较长的单词可取单词的头几个字母形成缩写;一些单词有大家公认的缩写。 示例: 如下单词的缩写能够被大家基本认可。 temp可缩写为tmp;flag可缩写为flg;statistic可缩写为stat;increment可缩写为inc;message可缩写为msg; 3-2: 命名中若使用特殊约定或缩写,则要有注释说明。 说明: 应该在源文件的开始之处,对文件中所使用的缩写或约定,特别是特殊的缩写,进行必要的注释说明。 3-3: 自己特有的命名风格,要自始至终保持一致,不可来回变化。 说明: 个人的命名风格,在符合所在项目组或产品组的命名规则的前提下,才可使用。 (即命名规则中没有规定到的地方才可有个人命名风格)。 3-4: 对于变量命名,禁止取单个字符(如i、j、k...),建议除了要有具体含义外,还能表明其变量类型、数据类型等,但i、j、k作局部循环变量是允许的。 说明: 变量,尤其是局部变量,如果用单个字符表示,很容易敲错(如i写成j),而编译时又检查不出来,有可能为了这个小小的错误而花费大量的查错时间。 示例: 下面所示的局部变量名的定义方法可以借鉴。 intliv_Width 其变量名解释如下: l 局部变量(Local)(其它: g 全局变量(Global)...) i 数据类型(Interger) v 变量(Variable)(其它: c 常量(Const)...) Width变量含义 这样可以防止局部变量与全局变量重名。 3-5: 命名规范必须与所使用的系统风格保持一致,并在同一项目中统一,比如采用UNIX的全小写加下划线的风格或大小写混排的方式,不要使用大小写与下划线混排的方式,用作特殊标识如标识成员变量或全局变量的m_和g_,其后加上大小写混排的方式是允许的。 示例: Add_User不允许,add_user、AddUser、m_AddUser允许。 3-6: 除非必要,不要用数字或较奇怪的字符来定义标识符。 示例: 如下命名,使人产生疑惑。 #define_EXAMPLE_0_TEST_ #define_EXAMPLE_1_TEST_voidset_sls00(BYTEsls);应改为有意义的单词命名 #define_EXAMPLE_UNIT_TEST_ #define_EXAMPLE_ASSERT_TEST_ voidset_udt_msg_sls(BYTEsls); 3-7: 在同一软件产品内,应规划好接口部分标识符(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。 说明: 对接口部分的标识符应该有更严格限制,防止冲突。 如可规定接口部分的变量与常量之前加上“模块”标识等。 3-8: 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等。 说明: 下面是一些在软件中常用的反义词组。 add/removebegin/endcreate/destroyinsert/deletefirst/lastget/release increment/decrementput/getadd/deletelock/unlockopen/closemin/maxold/newstart/stopnext/previoussource/targetshow/hide send/receivesource/destinationcut/pasteup/down 示例: intmin_sum; intmax_sum; intadd_user(BYTE*user_name); intdelete_user(BYTE*user_name); 3-9: 除了编译开关/头文件等特殊应用,应避免使用_EXAMPLE_TEST_之类以下划线开始和结尾的定义。 4可读性 4-1: 注意运算符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级。 说明: 防止阅读程序时产生误解,防止因默认的优先级与设计思想不符而导致程序出错。 示例: 下列语句中的表达式 word=(high<<8)|low (1) if((a|b)&&(a&c)) (2)if((a|b)<(c&d))(3)如果书写为 high<<8|lowa|b&&a&ca|b high<<8|low=(high<<8)|low, a|b&&a&c=(a|b)&&(a&c), (1) (2)不会出错,但语句不易理解; a|b 4-2: 避免使用不易理解的数字,用有意义的标识来替代。 涉及物理状态或者含有物理意义的常量,不应直接使用数字,必须用有意义的枚举或宏来代替。 示例: 如下的程序可读性差。 if(Trunk[index].trunk_state==0) { Trunk[index].trunk_state=1; ...//programcode } 应改为如下形式。 #defineTRUNK_IDLE0 #defineTRUNK_BUSY1 if(Trunk[index].trunk_state==TRUNK_IDLE) { Trunk[index].trunk_state=TRUNK_BUSY; ...//programcode } 4-3: 源程序中关系较为紧密的代码应尽可能相邻。 说明: 便于程序阅读和查找。 示例: 以下代码布局不太合理。 rect.length=10; char_poi=str; rect.width=5;若按如下形式书写,可能更清晰一些。 rect.length=10; rect.width=5;//矩形的长与宽关系较密切,放在一起。 char_poi=str; 4-4: 不要使用难懂的技巧性很高的语句,除非很有必要时。 说明: 高技巧语句不等于高效率的程序,实际上程序的效率关键在于算法。 示例: 如下表达式,考虑不周就可能出问题,也较难理解。 *stat_poi+++=1; *++stat_poi+=1; 应分别改为如下。 *stat_poi+=1; stat_poi++;//此二语句功能相当于“*stat_poi+++=1;” ++stat_poi; *stat_poi+=1;//此二语句功能相当于“*++stat_poi+=1;” 5变量、结构 5-1: 去掉没必要的公共变量。 说明: 公共变量是增大模块间耦合的原因之一,故应减少没必要的公共变量以降低模块间的耦合度。 5-2: 仔细定义并明确公共变量的含义、作用、取值范围及公共变量间的关系。 说明: 在对变量声明的同时,应对其含义、作用及取值范围进行注释说明,同时若有必要还应说明与其它变量的关系。 RELATION System_Init Input_Rec Print_Rec Stat_Score Student Create Modify Access Access Score Create Modify Access Access,Modify 5-3: 明确公共变量与操作此公共变量的函数或过程的关系,如访问、修改及创建等。 说明: 明确过程操作变量的关系后,将有利于程序的进一步优化、单元测试、系统联调以及代码维护等。 这种关系的说明可在注释或文档中描述。 示例: 在源文件中,可按如下注释形式说明。 注: RELATION为操作关系;System_Init、Input_Rec、Print_Rec、Stat_Score为四个不同的 函数;Student、Score为两个全局变量;Create表示创建,Modify表示修改,Access表示访问。 其中,函数Input_Rec、Stat_Score都可修改变量Score,故此变量将引起函数间较大的耦合,并可能增加代码测试、维护的难度。 5-4: 当向公共变量传递数据时,要十分小心,防止赋与不合理的值或越界等现象发生。 说明: 对公共变量赋值时,若有必要应进行合法性检查,以提高代码的可靠性、稳定性。 5-5: 防止局部变量与公共变量同名。 说明: 若使用了较好的命名规则,那么此问题可自动消除。 5-6: 严禁使用未经初始化的变量作为右值。 说明: 特别是在C/C++中引用未经赋值的指针,经常会引起系统崩溃。 5-7: 结构的功能要单一,是针对一种事务的抽象。 说明: 设计结构时应力争使结构代表一种现实事务的抽象,而不是同时代表多
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 语言 编程 规范 总则
![提示](https://static.bdocx.com/images/bang_tan.gif)