C语言编程及命名规范.ppt

《C语言编程及命名规范.ppt》由会员分享，可在线阅读，更多相关《C语言编程及命名规范.ppt（40页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、C语言命名及编程规范CXL2007.07.26前言规范的重要性今天人们越来越明白软件设计更多地是一种工程，而不是一种个人艺术。由于大型产品的开发通常由很多的人协同作战，如果不统一编程规范，最终合到一起的程序，其可读性将较差，这不仅给代码的理解带来障碍，增加维护阶段的工作量，同时不规范的代码隐含错误的可能性也比较大。前言规范的重要性vBELL实验室的研究资料表明，软件错误中18%左右产生于概要设计阶段，15%左右产生于详细设计阶段，而编码阶段产生的错误占的比例则接近50%;分析表明，编码阶段产生的错误当中，语法错误大概占20%左右，而由于未严格检查软件逻辑导致的错误、函数(模块)之间接口错误及由

2、于代码可理解度低导致优化维护阶段对代码的错误修改引起的错误则占了一半以上。可见，提高软件质量必须降低编码阶段的错误率。如何有效降低编码阶段的错误呢?BELL实验室的研究人员制定了详细的软件编程规范，并培训每一位程序员，最终的结果把编码阶段的错误降至10%左右，同时也降低了程序的测试费用，效果相当显著。前言规范的重要性v本文从代码的可维护性(可读、可理解性、可修改性)、代码逻辑与效率、函数(模块)接口、可测试性四个方面阐述了软件编程规范；分为二个部分介绍，第一部分为命名规范，第二部分为编程规范。v本规范为天马公司强制执行项目。前言规范的重要性v我们制定一种编程风格，希望能达到以下目的：可移植(P

3、ortability)连贯(Consistency)整洁(Neatness)易于维护(Easymaintenance)易于理解(Easyunderstanding)简洁(Simplicity)在一个团队合作的大型项目中，这种风格要贯穿始终。采用通用的代码编写风格可以减轻代码维护的工作量并降低维护费用；这种通用的代码风格还可以避免重写代码。第一部分C语言命名规范v一、通则1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角,声母、韵母等。2、所有命名都应遵循达意原则，即名称应含义清晰、明确。3、所有命名都不易过长，应控制在规定的最

4、大长度以内,一般不超过32个字节。第一部分C语言命名规范v一、通则4、所有命名都应尽量使用全称。5、如果命名使用缩写，则尽量应该使用通用缩写；如不知道通用缩写，则必须对其进行注释和说明。6、缩写原则v形成缩写的几种技术:v1)去掉所有的不在词头的元音字母。如screen写成scrn,primtive写成prmv。第一部分C语言命名规范6、缩写原则v2)使用每个单词的头一个或几个字母。如ChannelActivation写成ChanActiv，ReleaseIndication写成RelInd。v3)使用变量名中每个有典型意义的单词。如CountofFailure写成FailCnt。v4)去掉无

5、用的单词后缀ing,ed等。如PagingRequest写成PagReq。v5)使用标准的或惯用的缩写形式(包括协议文件中出现的缩写形式)。如BSIC(BaseStationIdentificationCode)、MAP(MobileApplicationPart)。第一部分C语言命名规范6、缩写原则v关于缩写的准则:v1)缩写应该保持一致性。如Channel不要有时缩写成Chan，有时缩写成Ch。Length有时缩写成Len，有时缩写成len。v2)在源代码头部加入注解来说明协议相关的、非通用缩写。v3)标识符的长度不超过32个字符。第一部分C语言命名规范v二、具体规范1、工程名v根据项目来

6、命名，能反映项目的最主要特征。v例如：天马公司的Windows控制程序，项目名可命为TWIN2、文件名v基于工程名，开头3个字母应表明与哪一个工程相关。v后面的字母应能够区别不同的功能。v严格区分大小写。v长度不限于8.3格式，建议不多于30个字符。v若文件用于定义和实现函数(类)，建议文件名与函数（类）名保持一致。第一部分C语言命名规范2、文件名v例如：vTWIN项目的文件名的前三个字符为TW_,vTW_ToolPosmeter.cppvTW_MachParameter.cppvTW_SpindlePos.cpp等等第一部分C语言命名规范3、函数名v参照项目具体的命名规范。v推荐使用动宾结构

7、。函数名应清晰反映函数的功能、用途。v函数名最长不得超过30个字符。v函数名是复合词的，每个单词采用第一个字母大写，其它字母小写方式。v全局函数必须以小写前缀g开头。例如：longOpenControl(void)；第一部分C语言命名规范4、变量名v原则上，变量名的命名遵从匈牙利记法。即：前缀+类型+变量名v其中:v前缀是可选项可选项，以小写字母表示;v基本类型是必选项，以小写字母表示;v变量名是必选项，可多个单词(或缩写)合在一起，每个单词首字母大写。v变量名最长不得超过20个字符。第一部分C语言命名规范4、变量名v前缀列表如下:v前缀意义举例vms_类的静态成员变量ms_ListFuncv

8、m_类成员变量或m_ListBox,v模块级变量m_Sizevs_静态全局变量s_Countvg_普通全局变量g_MyVar第一部分C语言命名规范4、变量名v基本类型列表如下:v基本类型意义举例vb布尔bIsOKvby字节byNumvc字符cMyCharvi整数iTestNumbervu无符号整数uCountvul无符号长整数ulTimevw字 wPara第一部分C语言命名规范4、变量名v基本类型意义举例vdw双字dwParavl长型lParavf浮点数fTotalvd长浮点数dDatavh句柄hWndvp指针pTheWordvlp长指针lpCmdva数组aErr第一部分C语言命名规范4、变量

9、名v基本类型意义举例vsString字符串sTempvszNULL结束的字符串szTreesvenm枚举型enmDaysvxyx,y坐标xyPos第一部分C语言命名规范5、类名v类名反映具体含义，以清晰表达类的用途和功能为原则。v接口必须以大写I开头，代表Interface。v当名称由多个单词构成时，每一个单词的第一个字母必须大写。第一部分C语言命名规范6、宏和常量的命名v宏和常量的命名规则:单词的字母全部大写，各单词之间可用下划线隔开。命名举例:v例如：v#defineMAXNUMBER100v#defineMAX_SLOT_NUM8v#defineEI_ENCR_INFO0 x07v#de

10、fineDO(do)iRet=do;if(iRet)returniRet;第一部分C语言命名规范7、结构和结构成员的命名v结构名各单词的字母均为大写，单词间可用下划线连接。可用或不用typedef，但是要保持一致，不能有的结构用typedef，有的又不用。v结构变量加小写前缀“t。vtypedefstructPOINTvvintx;vinty;vtPOINT;v结构成员的命名同变量的命名规则。第一部分C语言命名规范8、枚举和枚举成员的命名v枚举名各单词的字母均为大写，单词间可用下划线隔开。v枚举成员的命名规则:单词的字母全部大写，各单词之间可用下划线隔开;要求各成员的第一个单词相同。v枚举变量

11、加小写前缀“e“.v命名举例:vtypedefenum_KFILE_OPEN_MODEvvFILE_OPEN_READONLY=0,vFILE_OPEN_READWRITE=1,vFILE_CREATE_ALWAY=3veKFILE_OPEN_MODE;第一部分C语言命名规范9、联合名v联合名各单词的字母均为大写，单词间可用下划线连接。v联合变量名加小写前缀“j“,其成员按变量命名。例：vtypedefunion_VARIANTvvcharcVal;vintiVal;vlonglVal;vfloatfVal;vjVARIANT;第二部分C语言编程规范v一、整体要求代码编写规则应该在建立在一个工

12、程项目之前。该规则应该贯穿整个项目的始终以保证代码的一致性。采用标准的代码编写惯例，可大大简化项目的维护负担。第二部分C语言编程规范v二、编程具体规范1、基本要求1.1程序结构清析，简单易懂，单个函数的程序行数一般不得超过200行。1.2代码精简，避免垃圾程序。1.3尽量使用预定义变量。1.4不要随意定义全局变量，尽量使用局部变量。1.5使用括号以避免二义性第二部分C语言编程规范2、可读性要求2.1可读性第一，效率第二。2.2保持注释与代码完全一致。2.3每个源程序文件，都有文件头说明，说明规格见规范。2.4每个函数，都有函数头说明，说明规格见规范。2.5主要变量定义或引用时，注释能反映其含义

13、。2.7定义全局变量要有相应说明。2.8处理过程的每个阶段都有相关注释说明。2.9在典型算法前都有注释。2.10在一行内只写一条语句，并采用空格、空行和移行保证清楚的视觉效果第二部分C语言编程规范2、可读性要求2.11利用缩进来显示程序的逻辑结构，缩进量一致定义为2个空格。2.12循环、分支层次不要超过五层。2.13注释可以与语句在同一行，也可以在上行。2.14空行和空白字符也是一种特殊注释。2.15一目了然的语句不加注释。2.16注释的作用范围可以为：定义、引用、条件分支以及一段代码。2.17注释行数（不包括程序头和函数头说明部份）应占总行数的1/5到1/3。第二部分C语言编程规范2、可读性

14、要求例一：函数的可读性格式longGetAxisStatus(intiAxisCode,long*lStatus)longlStatus;longlResult;SetAxisAddress(iAxisCode);lResult=GetStatus(lResult);returnlResult;以上函数内容缩进2个空格，可读性强。第二部分C语言编程规范2、可读性要求例二：一行只有一个语句，可用空格来对齐错误的例子：viLength=32,iWidth=16;正确的例子：viLength=32；viWidth=16；第二部分C语言编程规范2、可读性要求例三：if(for、while等)语句的使用

15、格式错误的例子：vif(a=3)vb=6;vvif(a=3)vvb=6;vv上例书写格式看起来没有层次感。第二部分C语言编程规范2、可读性要求例三：if(for、while等)语句的使用格式正确的例子：vif(a=3)vvb=6;vv内容缩进2个空格，层次清楚，可读性强。第二部分C语言编程规范2、可读性要求例四：switch语句的使用错误的例子：vswitch(code)vcase0:break;vcase1:vbreak;vdefault:vbreak;vv上例书写格式看起来没有层次感。第二部分C语言编程规范2、可读性要求例四：switch语句的使用正确的例子：vswitch(code)vv

16、case0:vbreak;vcase1:vbreak;vdefault:vbreak;vv内容缩进2个空格，层次清楚，可读性强。第二部分C语言编程规范3、结构化要求3.1禁止出现两条等价的支路。3.2一般禁止GOTO语句。3.3用IF语句来强调只执行两组语句中的一组。禁止ELSEGOTO。3.4用CASE实现多路分支。3.5避免从循环引出多个出口。3.6一般函数只有一个出口。3.7不使用条件赋值语句。3.8避免不必要的分支。3.9不要轻易用条件分支去替换逻辑表达式。第二部分C语言编程规范4、正确性与容错性要求4.1程序首先是正确，其次是优美4.2无法证明你的程序没有错误，因此在编写完一段程序后

17、，应先根据详细设计回头检查。4.3改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4.4所有变量在调用前必须被初始化。4.5对所有的用户输入，必须进行合法性检查。4.6程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、权限设定等。4.7单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。第二部分C语言编程规范5、可重用性要求5.1重复使用的完成相对独立功能的算法或代码应抽象为公共控件。5.2公共控件应考虑OO思想，减少外界联系，考虑独立性或封装性。5.3公共控件应建立使用模板。第二部分C语言编程规范6、注释6.1根据项目要求设定注释语言

18、;6.2文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明;6.3函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;6.4程序中注释包括:修改时间和作者、方便理解的注释等;第二部分C语言编程规范6、注释例一:文件开头的注释模板/*文件名：*Copyright(c)1993-2007*公司技术开发部*创建人：*日期：*功能描述：*版本：*修改人：*修改内容：*日期：*/第二部分C语言编程规范6、注释例二:函数开头的注释模板/*函数名:*输入:a，b*a-*b-*输出:x*x为1,表示.*x为0,表示.*功能描述:*/第二部分C语言编程规范6、注释例三:程序中（函数内部）的注释模板/注释内容代码；代码；/注释内容一般在函数内部的注释不用/*/，以避免屏蔽函数一些代码时产生错误。结束语谢谢大家，CXL