嵌入式系統中C語言的編寫規范

總是使用size_t作為長度或大小變量

如果函數不應該修改指針所指向的內存，則總是使用const作為指針

如果不應該修改函數的形參或變量，則總是使用const

/*Whendcouldbemodified,datapointedtobydcouldnotbemodified*/voidmy_func(constvoid*d){}/*Whendanddatapointedtobydbothcouldnotbemodified*/voidmy_func(constvoid*constd){}/*Notrequired,itisadvised*/voidmy_func(constsize_tlen){}/*Whendshouldnotbemodifiedinsidefunction,onlydatapointedtobydcouldbemodified*/voidmy_func(void*constd){}

• 當函數可以接受任何類型的指針時，總是使用void *，不要使用uint8_t *。函數在實現時必須注意正確的類型轉換

/**Tosenddata,functionshouldnotmodifymemorypointedtoby`data`variable*thus`const`keywordisimportant**Tosendgenericdata(ortowritethemtofile)*anytypemaybepassedfordata,*thususe`void*`*//*OKexample*/voidsend_data(constvoid*data,size_tlen){/*OK*//*Donotcast`void*`or`constvoid*`*/constuint8_t*d=data;/*Functionhandlespropertypeforinternalusage*/}voidsend_data(constvoid*data,intlen){/*Wrong,notnotuseint*/}

總是使用括號和sizeof操作符

不要使用變長數組。使用動態內存分配代替標準C malloc和自由函數，或者如果庫/項目提供了自定義內存分配，使用它的實現

看看LwMEM，一個自定義內存管理庫。

/*OK*/#includevoidmy_func(size_tsize){int32_t*arr;arr=malloc(sizeof(*arr)*n);/*OK,Allocatememory*/arr=malloc(sizeof*arr*n);/*Wrong,bracketsforsizeofoperatoraremissing*/if(arr==NULL){/*FAIL,nomemory*/}free(arr);/*Freememoryafterusage*/}/*Wrong*/voidmy_func(size_tsize){int32_tarr[size];/*Wrong,donotuseVLA*/}

總是將variable與0進行比較，除非它被視為布爾類型

永遠不要將布爾處理的變量與0或1進行比較。用NOT(!)代替

size_tlength=5;/*Countervariable*/uint8_tis_ok=0;/*Boolean-treatedvariable*/if(length)/*Wrong,lengthisnottreatedasboolean*/if(length>0)/*OK,lengthistreatedascountervariablecontainingmultivalues,notonly0or1*/if(length==0)/*OK,lengthistreatedascountervariablecontainingmultivalues,notonly0or1*/if(is_ok)/*OK,variableistreatedasboolean*/if(!is_ok)/*OK,-||-*/if(is_ok==1)/*Wrong,nevercomparebooleanvariableagainst1!*/if(is_ok==0)/*Wrong,use!fornegativecheck*/

• 對于注釋，總是使用/* comment */，即使是單行注釋

在頭文件中總是包含帶有extern關鍵字的c++檢查

每個函數都必須包含doxygen-enabled注釋，即使函數是靜態的

使用英文名稱/文本的函數，變量，注釋

變量使用小寫字母

如果變量包含多個名稱，請使用下劃線。force_redraw。不要使用forceRedraw

對于C標準庫的包含文件，請始終使用<和>。例如，# include < stdlib.h >

對于自定義庫，請始終使用""。例如，# include“my_library.h”

當轉換為指針類型時，總是將星號與類型對齊，例如。uint8_t* t = (uint8_t*)var_width_diff_type

始終尊重項目或庫中已經使用的代碼風格

注釋

• 不允許以//開頭的注釋?？偸鞘褂?* comment */，即使是單行注釋

//Thisiscomment(wrong)/*Thisiscomment(ok)*/

• 對于多行注釋，每行使用空格+星號

/**Thisismulti-linecomments,*writtenin2lines(ok)*//***Wrong,usedouble-asteriskonlyfordoxygendocumentation*//**Singlelinecommentwithoutspacebeforeasterisk(wrong)*//**Singlelinecommentinmulti-lineconfiguration(wrong)*//*Singlelinecomment(ok)*/

• 注釋時使用12個縮進(12 * 4個空格)偏移量。如果語句大于12個縮進，將注釋4-空格對齊(下面的例子)到下一個可用縮進

voidmy_func(void){chara,b;a=call_func_returning_char_a(a);/*Thisiscommentwith12*4spacesindentfrombeginningofline*/b=call_func_returning_char_a_but_func_name_is_very_long(a);/*Thisiscomment,alignedto4-spacesindent*/}

函數

每個可以從模塊外部訪問的函數都必須包含函數原型(或聲明)

函數名必須小寫，可以用下劃線_分隔

/*OK*/voidmy_func(void);voidmyfunc(void);/*Wrong*/voidMYFunc(void);voidmyFunc();

• 當函數返回指針時，將星號對齊到返回類型

/*OK*/constchar*my_func(void);my_struct_t*my_func(int32_ta,int32_tb);/*Wrong*/constchar*my_func(void);my_struct_t*my_func(void);

• 對齊所有的功能原型(使用相同/相似的功能)以提高可讀性

/*OK,functionnamesaligned*/voidset(int32_ta);my_type_tget(void);my_ptr_t*get_ptr(void);/*Wrong*/voidset(int32_ta);constchar*get(void);

• 函數實現必須在單獨的行中包含返回類型和可選的其他關鍵字

/*OK*/int32_tfoo(void){return0;}/*OK*/staticconstchar*get_string(void){return"Helloworld!rn";}/*Wrong*/int32_tfoo(void){return0;}

變量

• 使變量名全部小寫，下劃線_字符可選

/*OK*/int32_ta;int32_tmy_var;int32_tmyvar;/*Wrong*/int32_tA;int32_tmyVar;int32_tMYVar;

• 按類型將局部變量分組在一起

voidfoo(void){int32_ta,b;/*OK*/chara;charb;/*Wrong,chartypealreadyexists*/}

• 不要在第一個可執行語句之后聲明變量

voidfoo(void){int32_ta;a=bar();int32_tb;/*Wrong,thereisalreadyexecutablestatement*/}

• 你可以在下一個縮進級別中聲明新的變量

int32_ta,b;a=foo();if(a){int32_tc,d;/*OK,canddareinif-statementscope*/c=foo();int32_te;/*Wrong,therewasalreadyexecutablestatementinsideblock*/}

• 用星號聲明指針變量與類型對齊

/*OK*/char*a;/*Wrong*/char*a;char*a;

• 當聲明多個指針變量時，可以使用星號對變量名進行聲明

/*OK*/char*p,*n;

結構、枚舉類型定義

結構名或枚舉名必須小寫，單詞之間有下劃線_字符

結構或枚舉可以包含typedef關鍵字

所有結構成員都必須小寫

所有枚舉成員必須是大寫的

結構/枚舉必須遵循doxygen文檔語法

在聲明結構體時，它可以使用以下三種不同的選項之一:

1、當結構體僅用名稱聲明時，它的名稱后不能包含_t后綴。

structstruct_name{char*a;charb;};

2、當只使用typedef聲明結構時，它的名稱后面必須包含_t后綴。

typedefstruct{char*a;charb;}struct_name_t;

3、當結構用name和typedef聲明時，它不能包含_t作為基本名稱，它必須在它的名稱后面包含_t后綴作為typedef部分。

typedefstructstruct_name{char*a;charb;charc;}struct_name_t;

錯誤聲明的例子及其建議的糾正：

/*aandbmustbeseparatedto2lines*//*Nameofstructurewithtypedefmustinclude_tsuffix*/typedefstruct{int32_ta,b;}a;/*Correctedversion*/typedefstruct{int32_ta;int32_tb;}a_t;/*Wrongname,itmustnotinclude_tsuffix*/structname_t{int32_ta;int32_tb;};/*Wrongparameters,mustbealluppercase*/typedefenum{MY_ENUM_TESTA,my_enum_testb,}my_enum_t;

• 在聲明時初始化結構時，使用C99初始化風格

/*OK*/a_ta={.a=4,.b=5,};/*Wrong*/a_ta={1,2};

• 當為函數句柄引入new typedef時，使用_fn后綴

/*Functionaccepts2parametersandreturnsuint8_t*//*Nameoftypedefhas`_fn`suffix*/typedefuint8_t(*my_func_typedef_fn)(uint8_tp1,constchar*p2);

復合語句

每個復合語句必須包括左花括號和右花括號，即使它只包含1個嵌套語句

每個復合語句必須包含單個縮進;嵌套語句時，每個嵌套包含1個縮進大小

/*OK*/if(c){do_a();}else{do_b();}/*Wrong*/if(c)do_a();elsedo_b();/*Wrong*/if(c)do_a();elsedo_b();

• 在if或if-else-if語句的情況下，else必須與第一條語句的右括號在同一行

/*OK*/if(a){}elseif(b){}else{}/*Wrong*/if(a){}else{}/*Wrong*/if(a){}else{}

• 在do-while語句的情況下，while部分必須與do部分的右括號在同一行

/*OK*/do{int32_ta;a=do_a();do_b(a);}while(check());/*Wrong*/do{/*...*/}while(check());/*Wrong*/do{/*...*/}while(check());

• 每一個開括號都需要縮進

if(a){do_a();}else{do_b();if(c){do_c();}}

• 不要做沒有花括號的復合語句，即使是單個語句。下面的例子展示了一些不好的做法

if(a)do_b();elsedo_c();if(a)do_a();elsedo_b();

• 空while循環、do-while循環或for循環必須包含花括號

/*OK*/while(is_register_bit_set()){}/*Wrong*/while(is_register_bit_set());while(is_register_bit_set()){}while(is_register_bit_set()){}

• 如果while(或for、do-while等)為空(嵌入式編程中也可能是這種情況)，請使用空的單行括號

/*Waitforbittobesetinembeddedhardwareunituint32_t*addr=HW_PERIPH_REGISTER_ADDR;/*Waitbit13tobeready*/while(*addr&(1

/*Notrecommended*/int32_ta=0;while(a

/*OK,everycasehassingleindent*//*OK,everybreakhasadditionalindent*/switch(check()){case0:do_a();break;case1:do_b();break;default:break;}/*Wrong,caseindentmissing*/switch(check()){case0:do_a();break;case1:do_b();break;default:break;}/*Wrong*/switch(check()){case0:do_a();break;/*Wrong,breakmusthaveindentasitisundercase*/case1:do_b();/*Wrong,indentundercaseismissing*/break;default:break;}

/*OK*/switch(var){case0:do_job();break;default:break;}/*Wrong,defaultismissing*/switch(var){case0:do_job();break;}

switch(a){/*OK*/case0:{int32_ta,b;charc;a=5;/*...*/break;}/*Wrong*/case1:{int32_ta;break;}/*Wrong,breakshallbeinside*/case2:{int32_ta;}break;}

/*OK*/#defineMY_MACRO(x)((x)*(x))/*Wrong*/#definesquare(x)((x)*(x))

/*OK*/#defineMIN(x,y)((x)

/*Wrong*/#defineMIN(x,y)(x)

typedefstruct{int32_tpx,py;}point_t;point_tp;/*Definenewpoint*//*Wrongimplementation*//*Definemacrotosetpoint*/#defineSET_POINT(p,x,y)(p)->px=(x);(p)->py=(y)/*2statements.Lastoneshouldnotimplementsemicolon*/SET_POINT(&p,3,4);/*Setpointtoposition3,4.Thisevaluatesto...*/(&p)->px=(3);(&p)->py=(4);/*...tothis.Inthisexamplethisisnotaproblem.*//*Considerthisuglycode,howeveritisvalidbyCstandard(notrecommended)*/if(a)/*Ifaistrue*/if(b)/*Ifbistrue*/SET_POINT(&p,3,4);/*Setpointtox=3,y=4*/elseSET_POINT(&p,5,6);/*Setpointtox=5,y=6*//*Evaluatestocodebelow.Doyouseetheproblem?*/if(a)if(b)(&p)->px=(3);(&p)->py=(4);else(&p)->px=(5);(&p)->py=(6);/*Orifwerewriteitalittle*/if(a)if(b)(&p)->px=(3);(&p)->py=(4);else(&p)->px=(5);(&p)->py=(6);/**Askyourselfaquestion:Towhich`if`statement`else`keywordbelongs?**Basedonfirstpartofcode,answerisstraight-forward.Toinner`if`statementwhenwecheck`b`condition*Actualanswer:Compilationerroras`else`belongsnowhere*//*Betterandcorrectimplementationofmacro*/#defineSET_POINT(p,x,y)do{(p)->px=(x);(p)->py=(y);}while(0)/*2statements.Nosemicolonafterwhileloop*//*Orevenbetter*/#defineSET_POINT(p,x,y)do{/*Backslashindicatesstatementcontinuesinnewline*/(p)->px=(x);(p)->py=(y);}while(0)/*2statements.Nosemicolonafterwhileloop*//*Noworiginalcodeevaluatesto*/if(a)if(b)do{(&p)->px=(3);(&p)->py=(4);}while(0);elsedo{(&p)->px=(5);(&p)->py=(6);}while(0);/*Everypartof`if`or`else`containsonly`1`innerstatement(do-while),hencethisisvalidevaluation*//*Tomakecodeperfect,usebracketsforeveryif-ifelse-elsestatements*/if(a){/*Ifaistrue*/if(b){/*Ifbistrue*/SET_POINT(&p,3,4);/*Setpointtox=3,y=4*/}else{SET_POINT(&p,5,6);/*Setpointtox=5,y=6*/}}

/*OK*/#ifdefined(XYZ)#ifdefined(ABC)/*dowhenABCdefined*/#endif/*defined(ABC)*/#else/*defined(XYZ)*//*DowhenXYZnotdefined*/#endif/*!defined(XYZ)*//*Wrong*/#ifdefined(XYZ)#ifdefined(ABC)/*dowhenABCdefined*/#endif/*defined(ABC)*/#else/*defined(XYZ)*//*DowhenXYZnotdefined*/#endif/*!defined(XYZ)*/

/***briefHoldspointertofirstentryinlinkedlist*Beginningofthistextis5tabs(20spaces)frombeginningofline*/statictype_t*list;

/***briefThisispointstruct*noteThisstructureisusedtocalculateallpoint*relatedstuff*/typedefstruct{int32_tx;/*!

/***briefSum`2`numbers*param[in]a:Firstnumber*param[in]b:Secondnumber*returnSumofinputvalues*/int32_tsum(int32_ta,int32_tb){returna+b;}/***briefSum`2`numbersandwriteittopointer*noteThisfunctiondoesnotreturnvalue,itstoresittopointerinstead*param[in]a:Firstnumber*param[in]b:Secondnumber*param[out]result:Outputvariableusedtosaveresult*/voidvoid_sum(int32_ta,int32_tb,int32_t*result){*result=a+b;}

/***briefMyenumeration*/typedefenum{MY_ERR,/*!

/***briefGetdatafrominputarray*param[in]in:Inputdata*returnPointertooutputdataonsuccess,`NULL`otherwise*/constvoid*get_data(constvoid*in){returnin;}

/***briefGetminimalvaluebetween`x`and`y`*param[in]x:Firstvalue*param[in]y:Secondvalue*returnMinimalvaluebetween`x`and`y`*hideinitializer*/#defineMIN(x,y)((x)

/***filetemplate.h*briefTemplateincludefile*//*Hereisemptyline*/

/***filetemplate.h*briefTemplateincludefile*//**Copyright(c)yearFirstNameLASTNAME**Permissionisherebygranted,freeofcharge,toanyperson*obtainingacopyofthissoftwareandassociateddocumentation*files(the"Software"),todealintheSoftwarewithoutrestriction,*includingwithoutlimitationtherightstouse,copy,modify,merge,*publish,distribute,sublicense,and/orsellcopiesoftheSoftware,*andtopermitpersonstowhomtheSoftwareisfurnishedtodoso,*subjecttothefollowingconditions:**Theabovecopyrightnoticeandthispermissionnoticeshallbe*includedinallcopiesorsubstantialportionsoftheSoftware.**THESOFTWAREISPROVIDED"ASIS",WITHOUTWARRANTYOFANYKIND,*EXPRESSORIMPLIED,INCLUDINGBUTNOTLIMITEDTOTHEWARRANTIES*OFMERCHANTABILITY,FITNESSFORAPARTICULARPURPOSE*ANDNONINFRINGEMENT.INNOEVENTSHALLTHEAUTHORSORCOPYRIGHT*HOLDERSBELIABLEFORANYCLAIM,DAMAGESOROTHERLIABILITY,*WHETHERINANACTIONOFCONTRACT,TORTOROTHERWISE,ARISING*FROM,OUTOFORINCONNECTIONWITHTHESOFTWAREORTHEUSEOR*OTHERDEALINGSINTHESOFTWARE.**Thisfileispartoflibrary_name.**Author:FirstNameLASTNAME*/

/*file.h...*/#ifndef...externint32_tmy_variable;/*Thisisglobalvariabledeclarationinheader*/#endif/*file.c...*/int32_tmy_variable;/*Actuallydefinedinsource*/

/*Licensecomeshere*/#ifndefTEMPLATE_HDR_H#defineTEMPLATE_HDR_H/*Includeheaders*/#ifdef__cplusplusextern"C"{#endif/*__cplusplus*//*Filecontenthere*/#ifdef__cplusplus}#endif/*__cplusplus*/#endif/*TEMPLATE_HDR_H*/