《C语言编程规范精品资料.docx》由会员分享，可在线阅读，更多相关《C语言编程规范精品资料.docx（61页珍藏版）》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、C语言编程规范(仅供参考)1. 基本要求1.1 程序结构清析，简单易懂，单个函数的程序行数不得超过100行。1.2 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。1.3 尽量使用标准库函数和公共函数。1.4 不要随意定义全局变量，尽量使用局部变量。1.5 使用括号以避免二义性。2.可读性要求2.1 可读性第一，效率第二。2.2 保持注释与代码完全一致。2.3 每个源程序文件，都有文件头说明，说明规格见规范。2.4 每个函数，都有函数头说明，说明规格见规范。2.5 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。2.7 常量定义（DEFINE）有相应说明。2.8 处理过程
2、的每个阶段都有相关注释说明。2.9 在典型算法前都有注释。2.10 利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为 6个字节。2.11 循环、分支层次不要超过五层。2.12 注释可以与语句在同一行，也可以在上行。2.13 空行和空白字符也是一种特殊注释。2.14 一目了然的语句不加注释。2.15 注释的作用范围可以为：定义、引用、条件分支以及一段代码。2.16 注释行数（不包括程序头和函数头说明部份）应占总行数的 1/5 到 1/3 。3. 结构化要求3.1 禁止出现两条等价的支路。3.2 禁止GOTO语句。3.3 用 IF 语句来强调只执行两组语句中的一组。禁止 E
3、LSE GOTO 和 ELSE RETURN。3.4 用 CASE 实现多路分支。3.5 避免从循环引出多个出口。3.6 函数只有一个出口。3.7 不使用条件赋值语句。3.8 避免不必要的分支。3.9 不要轻易用条件分支去替换逻辑表达式。4. 正确性与容错性要求4.1 程序首先是正确，其次是优美4.2 无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。4.3 改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。4.4 所有变量在调用前必须被初始化。4.5 对所有的用户输入，必须进行合法性检查。4.6 不要比较浮点数的相等，如： 10.0 * 0.1 = 1.0 ，
4、 不可靠4.7 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等。4.8 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。5. 可重用性要求5.1 重复使用的完成相对独立功能的算法或代码应抽象为公共控件或类。5.2 公共控件或类应考虑OO思想，减少外界联系，考虑独立性或封装性。5.3 公共控件或类应建立使用模板。附：C 编程规范,delphi作相应的参考1适用范围本标准适用于利用Visul C+ ,Borland C+进行软件程序开发的人员.。.2变量命名命名必须具有一定的实际意义,形式为xAbcFgh,x由变量类型确定,Abc、Fg
5、h表示连续意义字符串,如果连续意义字符串仅两个,可都大写.如OK.具体例程:BOOL类型 bEnable;ch *char chTextc * 类对象 cMain（对象实例）h * Handle（句柄） hWndi * intn * 无符号整型p * 指针sz,str * 字符串w WORDx,y 坐标Char或者TCHAR类型 与Windows API有直接联系的用szAppName10形式否则用FileName10形式,单个字符也可用小写字母表示;Int类型 nCmdShow;LONG类型 lParam;UINT类型 uNotify;DWORD类型 dwStart;PSTR类型 pszTi
6、p;LPSTR类型 lpCmdLineLPTSTR类型 lpszClassName;LPVOID类型 lpReservedWPARAM类型 wParam,LPARAM类型 lParamHWND类型 hDlg;HDC类型 hDC;HINSTANCE类型 hInstanceHANDLE类型 hInstance,HICON类型 hIcon;int iTmpfloat fTmpDWORD dw*String , AnsiString str *m_ 类成员变量 m_nVal, m_bFlagg_ 全局变量 g_nMsg, g_bFlag局部变量中可采用如下几个通用变量：nTemp，nResult，I，
7、J（一般用于循环变量）。其他资源句柄同上.3常量命名和宏定义常量和宏定义必须具有一定的实际意义;常量和宏定义在#include和函数定义之间;常量和宏定义必须全部以大写字母来撰写,中间可根据意义的连续性用下划线连接,每一条定义的右侧必须有一简单的注释,说明其作用;资源名字定义格式:菜单:IDM_XX或者CM_XX位图:IDB_XX对话框:IDD_XX字符串:IDS_XXDLGINIT:DIALOG_XXICON:IDR_XX.4函数命名函数原型说明包括引用外来函数及内部函数，外部引用必须在右侧注明函数来源：模块名及文件名, 如是内部函数，只要注释其定义文件名;第一个字母必须使用大写字母,要求用
8、大小写字母组合规范函数命名,必要时可用下划线间隔,示例如下：voidUpdateDB_Tfgd (TRACK_NAME); file:/ModuleName :r01/sdw.cvoidPrintTrackData (TRACK_NAME); file:/Module Name :r04/tern.cvoidImportantPoint (void); file:/ModuleName :r01/sdw.cvoidShowChar (int , int , chtype); file:/Local ModulevoidScrollUp_V(int , int); file:/Local Mod
9、ule.5结构体命名结构体类型命名必须全部用大写字母,原则上前面以下划线开始;结构体变量命名必须用大小写字母组合，第一个字母必须使用大写字母,必要时可用下划线间隔。对于私有数据区，必须注明其所属的进程。全局数据定义只需注意其用途。 示例如下： typedef struct char szProductName20; char szAuthor20; char szReleaseDate16; char szVersion10; unsigned long MaxTables; unsigned long UsedTables;DBS_DATABASE;DBS_DATABASE GdataBas
10、e;6 控件的命名：用小写前缀表示类别用小写前缀表示类别：fm 窗口cmd 按钮cob combo，下拉式列表框txt 文本输入框lab labal，标签img image，图象pic picturegrd Grid，网格scr 滚动条lst 列表框frm fram7注释原则上注释要求使用中文;文件开始注释内容包括:公司名称、版权、作者名称、时间、模块用途、背景介绍等,复杂的算法需要加上流程说明;函数注释包括:输入、输出、函数描述、流程处理、全局变量、调用样例等,复杂的函数需要加上变量用途说明;程序中注释包括:修改时间和作者、方便理解的注释等;引用一: 文件开头的注释模板/* 文件名:* Co
11、pyright (c) 1998-1999 *公司技术开发部* 创建人:* 日期:* 修改人:* 日期:* 描述:* 版本:*-*/引用二: 函数开头的注释模板/* 函数名:* 输入: a,b,c* a-* b-* c-* 输出: x-*x 为 1, 表示.*x 为 0, 表示.* 功能描述:* 全局变量:* 调用模块:* 作者:* 日期:* 修改:* 日期:* 版本*/引用三: 程序中的注释模板/*-*/* 注释内容 */*-*/8 程序a. 程序编码力求简洁，结构清晰，避免太多的分支结构及太过于技巧性的程序，尽量不采用递归模式。b. 编写程序时，亦必须想好测试的方法，换句话说，”单元测试”
12、 的测试方案应在程序编写时一并拟好。c. 注释一定要与程序一致。d. 版本封存以后的修改一定要将老语句用/* */ 封闭，不能自行删除或修改,并要在文件及函数的修改记录中加以记录。e. 程序中每个block 的开头 ” 及 ” 必须对齐，嵌套的block 每进一套，缩进一个tab，TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。f.对于比较大的函数，每个block 和特殊的函数调用，都必须注明其功能，举例如下：count.divisor = 1193280 / freq; /compute the proper countOutByte(unsigned s
13、hort)67, (unsigned char)182);/tell 8253 that acount is comingOutByte(unsigned short)66, count. c0);/send low-order byteOutByte(unsigned short)66, count. c1);/send high-order bytebcb，delphi中的变量命名：遵循匈牙利命名法，命名必须有意义，制定如下规定窗体：以大写的W开始，如About版权窗体， 命名为WAbout文件：以大写的F开始，如About版权窗体，文件命名为FAbout.cpp按钮(Button)：如退
14、出按钮，命名为btnExit基类：加base标记，如报表基类,窗体命名为：WBaseRep, 文件命名为FBaseRep.cpp转贴 1. 在.h/.cpp的开头应有一段格式统一的说明，内容包括： a. 文件名 (FileName)； b. 创建人 (Creater)； c. 文件创建时间 (Date)； d. 简短说明文件功能、用途 (Comment)。好习惯 2. 除非极其简单，否则对函数应有注释说明。内容包括：功能、入口/出口参数，必要 时还可有备注或补充说明。还是好习惯 3. 每列代码的长度推荐为 80列，最长不得超过120列；折行以对齐为准。太宽了，我的限制是60列，因为文本方式下屏
15、幕一共80列，如果你用BC这一类的编辑器，窗口边框等又要占据一定空间，所以80列太宽 4. 循环、分支代码，判断条件与执行代码不得在同一行上。很对 5. 指针的定义，* 号既可以紧接类型，也可以在变量名之前。 例：可写做：int*pnsize; 也可写做：int*pnsize; 但不得写做：int*pnsize;建议采用第二种，除非附加另外一条规定：一次只声明一个变量，否则就会让人混淆，比如：int* a, b;看起来b好像也是个指针，其实不是。 6. 在类的成员函数内调用非成员函数时，在非成员函数名前必须加上:。这一条我倒觉得并不是必需的，我的看法是决不要让你的类成员函数和全局函数的名称相同
16、（或类似） 7. 函数入口参数有缺省值时，应注释说明。 例：BOOL CWpsDib:PaintDIB(CDC* pDC, CRect& rc,int nBrightness, file:/*=0*/BOOL bGrayScale file:/*=FALSE*/ )每个变量写一行，必要时加上/*in, out*/注释 8. elseif 必须写在一行。应该尽量避免else if这样的结构 9. 与、有关的各项规定：9.1、应独占一行。在该行内可有注释。 9.2 必须另起一行， 之后的代码必须缩进一个Tab。与必须在同 一列上。 9.3 在循环、分支之后若只有一行代码，虽然可省略、，但不推荐这么
17、 做。若省略后可能引起歧义，则必须加上、。持保留意见，因为GNU的代码规范是这样的：if ( NULL = ptr )/ do something here或者if ( NULL = ptr ) / do something here争论哪个更好并没有意义，关键是统一，如果用VC当然你的办法最方便，可是如果你用emacs或者vi，就不是这样了。 10. 与空格有关的各项规定。 10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但 在、:、.、等运算符前后，及&（取地址）、* （取值）等运算符之后不得有空格。 10.2for、while、if 等关键词之后应有1个空格
18、，再接(，之后无空格；在结尾 的)前不得有空格。我认为在括号两端加空格并不是什么错误，尤其是在一个条件十分复杂的if语句里 10.3 调用函数、宏时，(、)前后不得有空格。 10.4类型强制转换时，()前后不得有空格同上 11. 与缩进有关的各项规定 11.1 缩进以 Tab 为单位。1 个 Tab 为 4 个空格我认为这个值应该更大，我自己使用8个空格，如果你的代码因为缩进幅度太大而导致折行，那么几乎可以肯定你的程序设计方案有问题。 11.2 下列情况，代码缩进一个 Tab: 1. 函数体相对函数名及、。 2. if、else、for、while、do 等之后的代码。 3. 一行之内写不下，
19、折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运 算符，则运算符应在上一行末尾，而不应在下一行的行首。这一条我反对，运算符应该放在下一行行首，以使人能清楚的知道这一行是续上一行的，比如if ( something& somethingelse& otherthings )如果写做if ( something &somethingelse &otherthings )反而看不清楚 11.3 下列情况，不必缩进：switch 之后的 case、default。编程规范与范例目 录1 排版 62 注释 113 标识符命名 184 可读性 205 变量、结构 226 函数、过程 28
20、7 可测性 368 程序效率 409 质量保证 4410 代码编辑、编译、审查 5011 代码测试、维护 5212 宏 53 1 排版1-1：程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。1-2：相对独立的程序块之间、变量说明之后必须加空行。示例：如下例子不符合规范。if (!valid_ni(ni) . / program coderepssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;应如下书写if (!valid_ni(ni) . / program code
21、repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;1-3：较长的语句（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。示例：perm_count_msg.head.len = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL );act_task_tableframe_id * STAT_TASK_CHECK_NUMBER + index.occu
22、pied = stat_poiindex.occupied;act_task_tabletaskno.duration_true_or_false = SYS_get_sccp_statistic_state( stat_item );report_or_not_flag = (taskno MAX_ACT_TASK_NUMBER) & (n7stat_stat_item_valid (stat_item) & (act_task_tabletaskno.result_data != 0); 1-4：循环、判断等语句中若有较长的表达式或语句，则要进行适应的划分，长表达式要在低优先级操作符处划分
23、新行，操作符放在新行之首。示例：if (taskno max_act_task_number) & (n7stat_stat_item_valid (stat_item) . / program codefor (i = 0, j = 0; (i BufferKeywordword_index.word_length) & (j NewKeyword.word_length); i+, j+) . / program codefor (i = 0, j = 0; (i first_word_length) & (j ），后不应加空格。说明：采用这种松散方式编写代码的目的是使代码更加清晰。由于留
24、空格所产生的清晰性是相对的，所以，在已经非常清晰的语句中没有必要再留空格，如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格，多重括号间不必加空格，因为在C/C+语言中括号已经是最清晰的标志了。在长语句中，如果需要加的空格非常多，那么应该保持整体清晰，而在局部不加空格。给操作符留空格时不要连续留两个以上空格。示例：(1) 逗号、分号只在后面加空格。int a, b, c; (2)比较操作符, 赋值操作符=、 +=，算术操作符+、%，逻辑操作符&、&，位域操作符= MAX_TIME_VALUE) a = b + c;a *= 2;a = b 2;(3)!、+、-、&（地址运算符
25、）等单目操作符前后不加空格。*p = a; / 内容操作*与内容之间flag = !isEmpty; / 非操作!与内容之间p = &mem; / 地址操作& 与内容之间i+; / +,-与内容之间(4)-、.前后不加空格。p-id = pid; / -指针前后不加空格(5) if、for、while、switch等与后面的括号间应加空格，使if等关键字更为突出、明显。if (a = b & c d) 1-1：一行程序以小于80字符为宜，不要写得过长。 2 注释2-1：一般情况下，源程序有效注释量必须在20以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太
26、少，注释语言必须准确、易懂、简洁。2-2：说明性文件（如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等）头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、与其它文件的关系、修改日志等，头文件的注释中还应有函数功能简要说明。示例：下面这段头文件的头注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Copyright (C), 1988-1999, Huawei Tech. Co., Ltd. File name: / 文件名 Author: Version: Date: / 作者、版本及完成日期 Description: / 用于
27、详细说明此程序文件完成的主要功能，与其他模块 / 或函数的接口，输出值、取值范围、含义及参数间的控 / 制、顺序、独立或依赖等关系 Others: / 其它内容的说明 Function List: / 主要函数列表，每条记录应包括函数名及功能简要说明 1. . History: / 修改历史记录列表，每条修改记录应包括修改日期、修改 / 者及修改内容简述 1. Date: Author: Modification: 2. .*/2-3：源文件头部应进行注释，列出：版权说明、版本号、生成日期、作者、模块目的/功能、主要函数及其功能、修改日志等。示例：下面这段源文件的头注释比较标准，当然，并不局限
28、于此格式，但上述信息建议要包含在内。/* 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 build this moudle */说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史
29、记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。2-4：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/* Function: / 函数名称 Description: / 函数功能、性能等的描述 Calls: / 被本函数调用的函数清单 Called By: / 调用本函数的函数清单 Table Accessed: / 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: / 被修改的表（此项仅对于牵扯到数据库操作的程序） I
30、nput: / 输入参数说明，包括每个参数的作 / 用、取值说明及参数间关系。 Output: / 对输出参数的说明。 Return: / 函数返回值的说明 Others: / 其它说明*/2-5：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2-6：注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。规则2-7：避免在注释中使用缩写，特别是非常用缩写。说明：在使用缩写时或之前，应对缩写进行必要的说明。2-8：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上
31、方则需与其上面的代码用空行隔开。示例：如下例子不符合规范。例1：/* get replicate sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;例2：repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;/* get replicate sub system index and net indicator */应如下书写/* get replica
32、te sub system index and net indicator */repssn_ind = ssn_dataindex.repssn_index;repssn_ni = ssn_dataindex.ni;2-9：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX_ACT_TASK_NUMBER 1000#define MAX_ACT_TASK_NUMBER 1000 /* active s
33、tatistic task number */2-10：数据结构声明(包括数组、结构、类、枚举等)，如果其命名不是充分自注释的，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个域的注释放在此域的右方。示例：可按如下形式说明枚举/数据/联合结构。/* 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 not */ /* transmission this message */ N_UNITDATA_REQ, /* sccp users unit data transmission request*/;2-11：全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。示例：/* The ErrorCode when SCC