C语言编程规范和约定.pdf

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

1、C语言编程规范和约定排版排版缩进 缩进 空行空行 空格 代码长度缩进缩进缩进量if(1=reset_flag)缩进量=4 用空格取代TABreset_state();else用空格取代TABelsefor(n=1;n20;n+)update_state();if(1=reset_flag)reset state();reset_state();elsefor(n=1;n=MAX_READ_SIZE)return1;flag=read_port_status();s32_tread_data(u8_t*buf,u32_tsize)空格的使用（建议）运算符=、=、+、*、/、=、BUF SIZE

2、1)?BUF SIZE 1:count+1;count=(count=BUF_SIZE1)?BUF_SIZE1:count+1;elseif(1=status)|(2=status)&(20=count)|(0=count)for(n=1;n、.前后不加空格前后不加空格+、前后不加空格（不要将+、用于有歧义的地方）数组名和之间、函数名和()之间不加空格if(1=reset flag)if(1=reset_flag)reset_state();ary 5+;ary 5+;dataflag=1;status.overflow=1;elsefor(n=1;n=BUF_SIZE1)?BUF_SIZE1

3、:count+1;elseif(1=status)|(2=status)|(8=status)()|()|()&(20=count)|(0=count)&(0=flag)for(n=1;n20;n+)index=read_port()+(count*sizeof(data_t);折行perm_count_msg.head.len=NO7_TO_STAT_PERM_COUNT_LEN+STAT_SIZE_PER_FRAM*sizeof(array);act_task_tableframe_id*STAT_TASK_CHECK_NUMBER+index.occupied=stat_poiindex

4、.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);&(act_task_tabletaskno.result_data!=0);for(i=0,j=0;(ifirst word length)&(jsecond word

5、 length);(ifirst_word_length)&(jsecond_word_length);i+,j+)./programcode./p og acode折行折行n7stat_str_compare(u8_t*)&stat_object,(u8 t*)&(act task tabletaskno stat object)(u8_t)&(act_task_tabletaskno.stat_object),sizeof(data_t);rect.length=0;rect.width=0;强制折行if(pUserCR=NULL)return;强制折行注释注释基本要求 基本要求 模板模板

6、基本要求基本要求 英文英文 需要大约20%的程序注释尽量让代码本身说明功能 尽量让代码本身说明功能 注释和程序一同更新 防止歧义 减少缩写 减少缩写 对于协议标准编程可以加入标准文献的索引(文献名称章节号)引(文献名称、章节号)注释位置注释位置 逻辑段落的注释放在段落前一行 语句的注释放在语句之后 注释和被注释的代码之间没有空行注释和被注释的代码之间没有空行voiddo_it()/functionoffollowinginitparagraphinit_data1();init data2();init_data2();/functionoffloowing doparagraphdo ste

7、p1();_p();do_step2();do_step3(3);/specialnotesonthisline注释位置注释位置length+;/increaselength/functionoffollowingcode没有必要注释g/去除空行if()do_func();注释方法注释方法尽量使用作为程序内部注释 尽量使用/作为程序内部注释/*/用于文件、函数头部注释段落/用于文件、函数头部注释段落 在不同条件下可能被使用的代码不能注释掉用 fd f掉，用#if0#endif注释内容注释内容文件头需要注释段落 文件开头需要注释段落 函数开头需要注释段落函数开头需要注释段落 全局变量需要详细注释

8、 特殊功能的局部变量需要详细注释 变量bit域详细注释变量bit域详细注释 为特殊功能的宏定义加注释注释例子注释例子#defineMAX ACT TASK NUMBER1000/activestatistictasknumber_/statevalueforglobalvariablestate#defineSTATE_A0#defineSTATE_B1#define STATE_C2/bitmaskforregisterREG_MODE,address0 xC000F000#defineBIT_MASK_RD(10)#defineBIT_MASK_IRQ(13)d fiSS(000)#def

9、ineBIT_MASK_START(0 xFF00)u8_tstatus;/bit0:overflow/bit1 3:co nter/bit13:counter/bit4:IRQstatus/注释例子注释例子voidexample_fun(void)/codeonecomments使用和代码相同的缩进do_a();do_b();的缩进voidexample fun(void)p_()/codeonecommentsdo_a();do_b();注释例子voidexample_fun(void)注释例子int n;for(n=0;n32;n+)switch(state)caseA:;break;b

10、reak;caseB:;break;default:;break;/switch(state)()/for(n=0;n32;n+)模板（文件头）模板（文件头）/*/*Copyright(C),20 xx20 xx,xxxGroupFilename:xxxDescription:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx总体Description:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxFunctionList:总体描述FunctionList:fun

11、c1:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxfunc2:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx主要函数描述History:Author:xxxVersion:xxxDate:xxxEmail:xxxDescription:Create数描述修改记录描述pAuthor:xxxVersion:xxxDate:xxxEmail:xxxDescription:Fixxxxbugs录描述*/模板（函数头）模板（函数头）/*/*Name:xxxx(函数名称)Description:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

12、xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx(函数功能、性能等的描述)Calls:xxxxxxxxxxxxxxxxxxxx(被本函数调用的主要函数清单)xxxxxxxxxx(被本函数调用的主要函数清单)Calledby:xxxxxxxxxxxxxxxx(调用本函数的函数清单)DataAccessed:xxxx(访问的公共数据、表格、数据库）DataAccessed:xxxx(访问的公共数据、表格、数据库）DataUpdated:xxxx(被修改的公共数据、表格、数据库）Inp

13、uts:xxxxxxxx(输入参数说明，参数作用、取值和参数间关系(输参数说明参数作用取值和参数间关系Outputs:xxxx(对输出参数的说明)Return:xxxx(函数返回值的说明)Others:xxxx(其它使用说明和注意事项)*/命名规则命名规则让程序句读起来接近自然言让程序语句读起来接近自然语言，提高可懂度 变量函数 函数 数据类型数据类型变量名称规则变量名称规则 模块前缀 全局变量完整起名严禁局部变量与全局变量重名 名词 形容词+名词形容词 名词 局部变量 名词名词 形容词+名词 m n k i j(通用的循环变量)m,n,k,i,j(通用的循环变量)通过前缀修饰p和g表明指针和

14、全局变量变量名称规则变量名称规则风格和风格 Unix风格和Win风格read_buffer_status;_;ReadBufferStatus;保持风格一致变量名称规则(例)变量名称规则(例)read_flag g read flag(前缀表明全局变量)g_read_flag(前缀表明全局变量)p_read_flag(前缀表明指针变量)TGUI_screen_height(前缀表明模块名称)TGUI g state;TGUI_g_state;变量命名缩写变量命名缩写 较短的单词可通过去掉“元音”形成缩写 较长的单词可取单词的头几个字母形成缩写 尽量使用公认的缩写。示例：示例：temp?tmp;

15、flag?flg;gg;statistic?stat;increment?inc;message?msg;变量命名规则变量命名规则不要用怪异的数字或字符不要用怪异的数字或字符#define MANY_$50000#define _EXAMPLE_1_TEST_ unsigned charflag 7742kivgtq;unsignedcharflag_7742kivgtq;命名规则命名规则 命名相对意义的变量（或函数）用明确的反义词对add/removebegin/endcreate/destroyput/getadd/deletelock/unlockopen/closesource/tar

16、getshow/hideinsert/deletefirst/lastget/releasemin/maxold/newstart/stop/send/receivesource/destinationcut/pasteincrement/decrementnext/previouspup/downint min_sum;int max_sum;全局变量全局变量尽量减少 尽量减少 起名要求易懂起名要求易懂 必须有统一的初始化函数 全局变量难以查找 全局变量对函数行为的影响隐蔽全局变量对函数行为的影响隐蔽 使用数据结构包容所有全局变量集合数据类型命名数据类型命名基本要求和变量命名规则样 基本要求

17、和变量命名规则一样 加后缀 t加后缀_ttypedef unsignedcharu8_tstruct head info tstruct head_info_t;常量起名规范常量起名规范基本要求和变量命名规则样 基本要求和变量命名规则一样 大写单词#define PI 3.14#define MAX BUFFER SIZE 256#define MAX_BUFFER_SIZE256constint READ_ERROR_FLAG4 注意常量宏的命名需要尽量完整，避免重注意常量宏的命名需要尽量完整，避免重名函数名称规则函数名称规则动词 名词（描述数据加工）动词+名词（描述数据加工）read_da

18、ta()clear_buffer()为防止重名，模块内函数建议使用前缀为防止重名，模块内函数建议使用前缀shell_read_buf();shell clear buf();shell_clear_buf();shell_reset();(对于不会被其他文件引用的函数可以加上 t ti(对于不会被其他文件引用的函数可以加上static修饰)编程规则编程规则定义数据宽度 定义数据宽度 typedef的使用typedef的使用 宏明确定义数据宽度明确定义数据宽度d fid h typedef unsignedcharu8_t typedef unsignedshort u16_typg_ type

19、def unsignedlongu32_t typedef signed chars8 t typedef signedchars8_t typedef signedshorts16_t typedef signedlongs32_t typedef long longs64 ttypedef longlongs64_ttypedef _int64s64_tstrcutstrcut typedef struct head_info_t;head info t g head info;head_info_t g_head_info;指针指针指针在定义时初始化置零 指针在定义时初始化置零 为指针申

20、请空间时建议采用下面方法if(p!=NULL)if(p!=NULL)print_warning(“discardnonzeropointern”);p=(data_type*)malloc(sizeof(data_type)*num);if(p=NULL)print_error(“failtoallocatepointern”);释放指针建议采用下面句子 释放指针建议采用下面句子if(p=NULL)print warning(“trying to free NULL pointern”);print_warning(tryingtofreeNULLpointern);elsefree(p);内

21、存申请(1)void*my_malloc(u32_tsize,char*name)if(i0)if(size(b)?(a):(b)#define MAX(a,b)(a)(b)?(a):(b)#defineARRAY_SIZE(a)(sizeof(a)/sizeof(a0)#defineBOOK(id)book_#id文件起名文件起名*h*.c,*.h,*.s c程序里面包含的#include代码*.hc尽量将可重用的代码和不可重用的代码分离 尽量将可重用的代码和不可重用的代码分离types.hd fihdefine.hconfig.hcommon h/common ccommon.h/comm

22、on.cmisc.h/misc.cincludes hincludes.hutil.h/util.c目录结构目录结构d l module1 src testbuild build misc data module2module2.c文件的结构c文件的结构版权声明 版权声明 文件用途说明编写和修改记录 编写和修改记录#include头文件 局部函数申明（只将会被外部引用的全局函数名称放在头文件里，其余的在c文件头部申明）全局变量申明（不能放在头文件里，头文件里面用extern申明供外部访问的全局变量）单个 程序长度少于行单个函数不要超过 单个c程序长度少于300行，单个函数不要超过100行函数编写函数编写缩进 缩进 Tab=4Tab 4 单独列出来对齐 换行使用UNIX风格