軟件開發(fā)代碼規(guī)范(C語言)

1、XX產(chǎn)品研究部收文：XX產(chǎn)品研究部軟件開發(fā)人員文檔版本：V0.11文檔編號產(chǎn)品版本密級開發(fā)適用共頁軟件開發(fā)代碼規(guī)范（僅供內(nèi)部使用）擬制：審核:核準(zhǔn):簽發(fā):日期:2011-5-11日期:日期:日期:目錄第一章原則4第二章排版52.1 空行52.2 代碼行62.3 代碼行內(nèi)的空格62.4 對齊縮進(jìn)72.5 長行拆分8第三章注釋103.1 通用規(guī)則103.2 文件注釋103.3 函數(shù)注釋113.4 數(shù)據(jù)注釋123.5 代碼注釋12第四章命名154.1 通用命名規(guī)則154.2 文件命名154.3 類型命名154.4 變量命名164.5 常量命名174.6 函數(shù)命名174.7 枚舉命名174.8 宏命名

2、1819第五章雜項(xiàng).文件修改記錄修改頁他、章節(jié)、修改日期版本條款修改描述作者2011-4-290.1創(chuàng)建初稿周超1)修改3.4數(shù)據(jù)注釋【規(guī)則3.3數(shù)據(jù)注釋3-4-3全局變量注釋例子2011-5-110.114.3類型命名4.4變量命名2)在“4.3類型命名”、“4.4變量周超命名”、“4.6函數(shù)命名”中，增加對4.6函數(shù)命名前綴、關(guān)鍵縮與詞等可以適當(dāng)全部大寫的處理。第一章原則本文檔的目的是提供一個(gè)公共的編碼規(guī)范。這個(gè)規(guī)范詳細(xì)闡述在編碼時(shí)要怎樣寫、不要怎樣寫，旨在提高代碼的可讀性、可維護(hù)性,使代碼易于管理，使所有人可以集中精力去實(shí)現(xiàn)內(nèi)容，而非處理各種復(fù)雜的表現(xiàn)形式。使代碼易于管理的方法之一是增強(qiáng)

3、代碼一致性，讓別人可以讀懂你的代碼是很重要的，保持統(tǒng)一編程風(fēng)格意味著可以輕松根據(jù)模式匹配”規(guī)則推斷各種符號的含義。創(chuàng)建通用的、必需的習(xí)慣用語和模式可以使代碼更加容易理解。雖然在某些情況下改變一些編程風(fēng)格可能會(huì)是好的選擇，但我們還是應(yīng)該遵循一致性原則，盡量不這樣去做。關(guān)鍵在于保持一致。第二章排版2.1 空行【規(guī)則2-1-1在每個(gè)函數(shù)、結(jié)構(gòu)體、枚舉定義結(jié)束之后都要加空行。行分隔【規(guī)則2-1-2在一個(gè)函數(shù)體內(nèi)，邏輯密切相關(guān)的語句之間不加空行，其它地方應(yīng)加空struct st1；/空行enum；/空行void Function1(/空行void Function2(函數(shù)之間的空行/空行while (c

4、ondition)(statement/空行if (condition)(statement2;)else(statement3;)/空行statement4;)函數(shù)內(nèi)部的空行【規(guī)則2-1-3相對獨(dú)立的程序塊之間、變量說明之后必須加空行f(!is_lock_card_succ)./programcodeGetLockPhonelnfo(&st_lock_phone_info)if(!is_lock_card_succ)(./programcode)/空格GetLockPhoneInfo(&stlockphoneinfo);不規(guī)范代碼規(guī)范代碼2.2 代碼行代碼容易閱讀，并且方執(zhí)行

5、語句有多少都要加【規(guī)則2-2-11一行代碼只做一件事情，如只定義一個(gè)變量，或只寫一條語句。這樣的便于寫注釋?！疽?guī)則2-2-2if、for、while、do等語句自占一行，執(zhí)行語句不得緊跟其后。不論什。這樣可以防止書寫失誤。intwidth,height,depth;/寬度局度深度intwidth;/寬度intheight;/高度intdepth;/深度X=a+b;y=c+d;z=e+f;x=a+b;y=c+d;z=e+f;if(width<height)dosomething();if(width<height)dosomething();for(initialization;co

6、ndition;update)dosomething();other();for(initialization;condition;update)dosomething();/空行other();不規(guī)范代碼規(guī)范代碼2.3 代碼行內(nèi)的空格說明：空格的目的在于更清晰的代碼。【規(guī)則2-3-1關(guān)鍵字之后要留空格。const、static等關(guān)鍵字之后至少要留一個(gè)空格，否則無法辨析關(guān)鍵字;if、for、while、switch等關(guān)鍵字之后應(yīng)留一個(gè)空格再跟左括號('以突出關(guān)鍵字?！疽?guī)則2-3-2函數(shù)名之后不要留空格，緊跟左括號('，以與關(guān)鍵字區(qū)別?！疽?guī)則2-3-3('向后緊跟，：&q

7、uot;；向前緊跟，緊跟處不留空格?！疽?guī)則2-3-4:'之后要留空格，如Function(x,y,z)。如果；不是一行的結(jié)束符號，其后要留空格，女口for(initialization;condition;update)。【規(guī)則2-3-5賦值操作符、比較操作符、算術(shù)操作符、邏輯操作符、位域操作符，如“二”"+="">=""<='""+”“*”“%，&&'、“<<”,“等二元操作符的前后應(yīng)當(dāng)加一個(gè)空格。【規(guī)則2-3-6】一元操作符如“！”“”“+”-"、

8、“&”（地址運(yùn)算符）等前后不加空格?！疽?guī)則2-3-7】象“口->這類操作符前后不加空格i<10; i+)【建議2-3-1】對于表達(dá)式比較長的for語句和if語句，為了緊湊起見可以適當(dāng)?shù)厝サ粢恍┛崭?，如for（i=0;良好風(fēng)格和if(a<=b)&&(c<=d)voidFunc1(intx,inty,intz);voidFunc1(intx,inty,intz);if(year>=2000)if(year>=2000)if(a>=b)&&(c<=d)if(a>=b)&&(c<=d)i

9、f(a>=b&&c<=d)for(i=0;i<10;i+)for(i=0;i<10;i+)for(i=0;i<10;i+)x=a<b?a:b;x=a<b?a:b;i+；int*x=&y;i+;int*x=&y;array5=0;a.Function();b->Function();array5=0;a.Function。；b->Function();不良風(fēng)2.4 對齊縮進(jìn)【規(guī)則2-4-1】程序塊要采用縮進(jìn)風(fēng)格編寫【規(guī)則2-4-2對齊使用TAB鍵，TAB鍵寬度設(shè)置為4個(gè)空格。說明：應(yīng)注意使用不同編輯器時(shí)，TAB

10、鍵設(shè)置不同造成的排版不同；應(yīng)注意某些編輯器在識(shí)別、顯示TAB鍵上存在問題；最終排版應(yīng)以在項(xiàng)目的主代碼編輯器（如VCSourceInsight等）中顯示一致統(tǒng)一、整潔清晰為準(zhǔn)。SourceInsight中設(shè)置：Options->DoucumentOptions->“TabWidth:4”【規(guī)則2-4-3函數(shù)或過程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語句中的代碼都要采用縮進(jìn)風(fēng)格，case語句下的情況處理語句也要遵從語句縮進(jìn)要求同時(shí)與if、【規(guī)則2-4-4】程序塊的分界符（如和'應(yīng)各獨(dú)占一行并且位于同一列，引用它們的語句左對齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及fo

11、r、do、while、switch、case語句中的程序都要采用如上的縮進(jìn)方式for(.)programcodefor(.)./programcodeif(.)programcodeif(.)./programcodevoidexample_fun(void)programcodevoidexample_fun(void)./programcode不規(guī)范代碼規(guī)范代碼【規(guī)則2-4-5預(yù)處理指令不需要縮進(jìn)，總是從行首開始。即使預(yù)處理指令位于縮進(jìn)代碼塊中，指令也應(yīng)從行首開始。/良好風(fēng)格：預(yù)處理指令均從行首開始if(lopsided_score)#ifDISASTER_PENDING/Correct-

12、StartsatbeginningoflineDropEverything();#ifNOTIFYNotifyClient();#endif#endifBackToNormal();/不良風(fēng)格：縮進(jìn)的預(yù)處理指令if(lopsided_score)#ifDISASTER_PENDING/Wrong!The"#if"shouldbeatbeginningoflineDropEverything();#endif/Wrong!Donotindent"#endif"BackToNormal();2.5長行拆分【規(guī)則2-5-1代碼行最大長度宜控制在100至110個(gè)

13、字符以內(nèi)。代碼行不要過長，否則眼睛看不過來，也不便于打印?！疽?guī)則2-5-2】較長的語句（110字符）要分成多行書寫；長表達(dá)式要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語句可讀。【規(guī)則2-5-3循環(huán)、判斷等語句中若有較長的表達(dá)式或語句，則要進(jìn)行適應(yīng)的劃分？長表達(dá)式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首?！疽?guī)則2-5-4若函數(shù)或過程中的參數(shù)較長，則要進(jìn)行適當(dāng)?shù)膭澐帧f(very_longer_variable1>=very_longer_variable12)&&(very_longer_var

14、iable3<=very_longer_variable14)&&(very_longer_variable5<=very_longer_variable16)dosomething();virtualCMatrixCMultiplyMatrix(CMatrixleftMatrix,CMatrixrightMatrix);for(very_longer_initialization;very_longer_condition;very_longer_update)dosomething();report_or_not_flag=(taskno<MAX_ACT_

15、TASK_NUMBER)&&(n7stat_stat_item_valid(stat_item)&&(acttasktabletaskno.resultdata!=0);n7stat_str_compare(BYTE*)&stat_object,(BYTE*)&(act_task_tabletaskno.stat_object),sizeof(STATOBJECT);長行的拆分第三章注釋3.1 通用規(guī)則【規(guī)則3-1-1一般情況，需要保證程序有一定的注釋。必須保證關(guān)鍵的函數(shù)、流程、類型定義、變量等有相應(yīng)注釋說明。說明：注釋的原則是有助于對程序的閱讀

16、理解，在該加的地方都加了，注釋不宜太多也不能太少，注釋語言必須準(zhǔn)確、易懂、?！疽?guī)則3-1-2注釋應(yīng)當(dāng)準(zhǔn)確、易懂，防止注釋有二義性。說明：錯(cuò)誤的注釋不但無益反而有害?！疽?guī)則3-1-3除非能使用準(zhǔn)確的英文表達(dá)，則使用中文注釋?！疽?guī)則3-1-4避免在注釋中使用縮寫，特別是非常用縮寫。說明：在使用縮寫時(shí)或之前，應(yīng)對縮寫進(jìn)行必要的說明?！疽?guī)則3-1-5】需要為代碼中使用的縮寫增加注釋，文件引入的新縮寫必須在文件頭部加以說明?！疽?guī)則3-1-6通過對函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。說明：清晰準(zhǔn)確的函數(shù)、變量等的命名，可增加代碼可讀性，并減少不必要的注釋?！疽?guī)則

17、3-1-7注釋格式盡量統(tǒng)一。建議使用進(jìn)行注釋，多行注釋可使用"/*?*?/"3.2 文件注釋【規(guī)則3-2】源文件（包含.h頭文件、.c源文件及各種腳本文件等）頭部應(yīng)進(jìn)行注釋，應(yīng)列出：版權(quán)說明、文件名、文件目的/功能，作者、創(chuàng)建日期等；如果源文件引入了新的縮寫，則必須在文件頭部注釋說明。文件注釋格式定義如下（可以不局限于該格式中定義的內(nèi)容，但必須包含該格式中定義的內(nèi)容）*Copyright（C）2010-2011,XXXCo.Ltd.*Allrightsreserved.FileName:/Description:/Author:/作者文件名稱文件描述* Date:/創(chuàng)建時(shí)間

18、* Others:/其它說明*/1mmmm*Abbreviatio n:/如果文件引入了新的縮寫，則必須在此處加以說明*/舉例如下：/*FileName:Descriptio n: NVAuthor:Date:Others:starlib_ nvset.h參藪配置源文件zc2010/4/13Copyright (C) 2010-2011, XXX Co. Ltd. All rights reserved.*/*Abbreviation:NCM: Net Choose Menu網(wǎng)絡(luò)選擇菜單VBC: Voice Broadcast語音播報(bào)*/3.3 函數(shù)注釋【規(guī)則3-3】函數(shù)頭部應(yīng)進(jìn)行注釋，需要列

19、出函數(shù)的功能、參數(shù)、返回值等。函數(shù)注釋格式定義如下（可以不局限于該格式中定義的內(nèi)容，但必須包含該格式中定義的/*/ Function:/函數(shù)名稱/ Descripti/ on:/ Param:/ Return:/ Others:/函數(shù)功能描述參數(shù)說明，包括參數(shù)的作用、取值范圍等，param1:輸入輸出類型IN/OUT/INOUTparam2:輸入輸出類型IN/OUT/INOUT函數(shù)返回值說明其它說明格式如下:說明說明/ Author:/作者/*/內(nèi)容）舉例如下:/*/Function:StarLib_SetldleNetlconTypeDescription:設(shè)置待機(jī)界面網(wǎng)絡(luò)圖標(biāo)PARAM:i

20、con:IN待機(jī)界面網(wǎng)絡(luò)圖標(biāo)Return:設(shè)置成功=STARLIBTRUE/設(shè)置失敗=STARLIB_FALSE/Others:/Author:zc/*/3.4數(shù)據(jù)注釋【規(guī)則3-4-1J對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。/activestatistictasknumber#defineMAX_ACT_TASK_NUMBER1000#defineMAX_ACT_TASK_NUMBER1000/activestatistictasknumber【規(guī)則3-4-2J數(shù)據(jù)結(jié)構(gòu)聲明（包括結(jié)構(gòu)體

21、、枚舉、類等），如果其命名不是充分自注釋的，必須加以注釋。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置；對結(jié)構(gòu)中每個(gè)域的注釋放在該域的右方。/sccpinterfacewithsccpuserprimitivemessagenameenumSCCP_USER_PRIMITIVEN_UNITDATA_IND,/sccpnotifysccpuserunitdatacomeN_NOTICE_IND,/*sccpnotifyusertheNo.7networkcannottransmissionthismessage*/N_UNITDATA_REQ,/sccpuser'sunitdatatransmi

22、ssionrequest;【規(guī)則3-4-3J全局變量必須有注釋，包括對其功能、取值、及其他注意事項(xiàng)等的說明。/標(biāo)志是否通過鎖卡流程；TURE=!過鎖卡流程，F(xiàn)ALSE哪卡流程失敗PUBLICBOOLEANgsLockCardPass=FALSE;3.5代碼注釋修改代碼同時(shí)修改相應(yīng)的注釋,以保證注釋與代碼的【規(guī)則3-5-1邊寫代碼邊注釋,-致性。不再有用的注釋要?jiǎng)h除！i+;/i力口1,多余的注釋【規(guī)則3-5-3在代碼的功能、意圖層次上進(jìn)行注釋，提供有用、額外的信息/ifreceive_flagisTRUEif(receive_flag)/ifmtpreceiveamessagefromlinks

23、if(receive_flag)【規(guī)則3-5-4注釋應(yīng)與其描述的代碼相鄰。對語句塊的注釋必須放在語句塊上方；對單條語句、變量定義的注釋可以放在上方或右方(建議放在右方)；注釋不可放在下方。/getreplicatesubsystemindexandnetindicatorrepssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;不良寫法一repssn_ind=ssn_dataindex.repssn_index;repssn_ni=ssn_dataindex.ni;/getreplicatesubsystemindexan

24、dnetindicator不良寫法二/getreplicatesubsystemindexandnetindicatorrepssn_ind=ssn_dataindex.repssn_index;repssnni=ssndataindex.ni;良好的寫法【規(guī)則3-5-5】如果注釋放在上方，則將注釋與其上面的代碼用空行隔方/codeonecommentsprogramcodeone/codetwocommentsprogramcodetwo/codeonecommentsprogramcodeone/codetwocommentsprogramcodetwo過于緊湊良好寫法【規(guī)則3-5-6避免

25、在一行代碼或表達(dá)式的中間插入注釋。說明：除非必要，不應(yīng)在代碼或表達(dá)中間插入注釋，否則容易使代碼可理解性變差?！疽?guī)則3-5-7】對于switch語句下的case語句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語句處理完、下一個(gè)case語句前加上明確的注釋。說明：這樣比較清楚程序編寫者的意圖，有效防止無故遺漏break語句。caseCMD_A:ProcessA();break;caseCMD_B:ProcessB();/跳轉(zhuǎn)至UcaseCMD_CcaseCMD_C:ProcessC();break;voidexample_fun(void)/codeoneco

26、mmentsCodeBlockOne/codetwocommentsCodeBlockTwovoidexample_fun(void)(/codeonecommentsCodeBlockOne/codetwocommentsCodeBlockTwo)不好的注釋縮排良好的注釋縮排第四章命名4.1 通用命名規(guī)則【規(guī)則4-1-1】標(biāo)識(shí)符的命名要清晰明了，有明確含義；命名應(yīng)具有描述性；一般而言,類型和變量應(yīng)是名詞，函數(shù)應(yīng)是命令性”動(dòng)詞；intcounter;/計(jì)數(shù)器一名詞NET_ICON_TYPEicon_type;NET_ICON_TYPE網(wǎng)絡(luò)圖標(biāo)類型一堵詞/設(shè)置IDLE頁面網(wǎng)絡(luò)圖標(biāo)類型令性”動(dòng)詞N

27、ET_ICON_TYPEStarLib_GetldleNetlconType（）;【規(guī)則4-1-2命名應(yīng)使用使用完整的單詞或大家可以理解的縮寫，避免使人產(chǎn)生誤解如使用特殊約定或縮寫，要有注釋說明，可參見【規(guī)則3-3；需注意避免過度縮寫。/良好命名intnum_error;intnum_connections;NETTYPEStarLibGetNetWorkType();/過度縮寫intnerr;intn_conns;NETTYPEStarLibGetNWType();4.2 文件命名【規(guī)則4-2】文件名全部小寫；為避免由于文件名過長造成難以理解，可以在適當(dāng)位置使用下劃線進(jìn)行分隔。不良的文件命名

28、：mmieventmanager.h（過長難以理解）Star_HttpServer.h（含大寫字母）良好的文件命名：starlib_nv.hmmi_applet_table.hmmiccspeeddial.c4.3 類型命名【規(guī)則4-3-1結(jié)構(gòu)體（struct）類型名遵循如下規(guī)則：每個(gè)單詞首字母大寫，單詞間使用下劃線相連，以_struct后綴結(jié)束；命名中的前綴、關(guān)鍵縮寫詞等可以適當(dāng)?shù)牟扇∪看髮?。struct的typedef類型定義名遵循如下規(guī)則：和struct名采用相同命名，但全部字母大寫，單詞間使用下劃線相連，并以_T后綴結(jié)束。一般而言，struct需同時(shí)定義類型名和typedef名。ty

29、pedefstructAUDIO_Codec_Ext_Cfglnfo_struct/AUDIO為前縱，米取全郃大與AUDIO_CODEC_EXT_CFGINFO_T;【規(guī)則4-3-2枚舉(enumj)類型名遵循如下規(guī)則：每個(gè)單詞首字母大寫，單詞間使用下劃線相連，以_enum后綴結(jié)束；命名中的前綴、關(guān)鍵縮寫詞等可以適當(dāng)?shù)牟扇∪看髮?。enum的typedef類型定義名遵循如下規(guī)則：和enum名采用相同命名，但全部字母大寫，單詞間使用下劃線相連，并以_E后綴結(jié)束。一般，enum無需定義類型名，僅需定義typedef名。typedefenumStar_Tel_Type_EnumSTARTELTYPE

30、E;【規(guī)則4-3-3函數(shù)指針(pointertofunction)的typdef名遵循如下規(guī)則：單詞全部字母大寫，單詞間使用下劃線相連，以PFUN后綴結(jié)束。typedefvoid(*AUDIO_NOTIFY_CALLBACK_PFUNC)(HAUDIOhAudio,uint32notify_info,uint32affix_info);4.4 變量命名【規(guī)則4-4-1J包括局部變量、全局變量、參數(shù)變量、成員變量，變量名一律小寫，單詞間使用下劃線相連；命名中的前綴、關(guān)鍵縮寫詞等可以適當(dāng)?shù)牟扇∪看髮憽２涣嫉拿篶har*strTable;大小寫混雜，放棄使用該種命名方式良好的命名：AW_LCD

31、_PARAM_Tlcd_param;charnv_phone_num10;voidStarLib_GetKeyRinglnfo(U8*key_type_ptr,U8*key_vol_ptr)；【規(guī)則4-4-2靜態(tài)全局變量使用s_前綴，普通全局變量使用g_前綴。ATC_INFO_Tg_atc_info_table10;普通全局變量staticBOOLEANsbatterystatus;靜態(tài)全局變量【規(guī)則4-4-3對于變量命名，禁止使用單個(gè)字符（如i、j、k等）。i、j、k等僅能用作局部循環(huán)變量。單個(gè)字母唯一可使用的場合for(i=0;i<max;i+)4.5常量命名【規(guī)則4-5-1 常量名全部字母大寫。4.6const floatconst intPI = 3.14;VAL_MIN = 1;函數(shù)命名【規(guī)則4-6-1 函數(shù)名中每個(gè)單詞首字母大寫；為避免由于函數(shù)名過長造成難以理解,可以在適當(dāng)位置使用下劃線進(jìn)行分隔;部大寫。命名中的前綴、關(guān)鍵縮寫詞等可以適當(dāng)?shù)牟扇∪涣嫉拿?charge_init(); 未采用正確的大小寫規(guī)則MMIAPICCProcessVideoCallPhoneNumExt();/函數(shù)名太長且沒有分隔，造成理解困難良好命名:Charge_Init();MMIAPICC_ProcessVideoCallPhoneNumExt(); /有