軟件編程規(guī)范總結(jié)

軟件編程規(guī)范總結(jié)本規(guī)范的內(nèi)容包括：基本原則、布局、注釋、命名規(guī)則、變量常量與類型、表達(dá)式與語句、函數(shù)與過程、可靠性、可測性、斷言與錯(cuò)誤處理等?；驹瓌t保持代碼的簡明清晰，避免過分的編程技巧。所有的代碼盡量遵循ANSIC標(biāo)準(zhǔn)。編程時(shí)首先達(dá)到正確性，其次考慮效率。避免或少用全局變量。盡量避免使用GOTO語句。盡可能重用、修正老的代碼。盡量減少同樣的錯(cuò)誤出現(xiàn)的次數(shù)。文件布局頭文件必須要避免重復(fù)包含。包含標(biāo)準(zhǔn)庫頭文件用尖括號<>，包含非標(biāo)準(zhǔn)庫頭文件用雙引號“”。遵循統(tǒng)一的順序書寫類的定義及實(shí)現(xiàn)。類的定義（在定義文件中）按如下順序書寫：公有屬性公有函數(shù)保護(hù)屬性保護(hù)函數(shù)私有屬性私有函數(shù)類的實(shí)現(xiàn)（在實(shí)現(xiàn)文件中）按如下順序書寫：構(gòu)造函數(shù)析構(gòu)函數(shù)公有函數(shù)保護(hù)函數(shù)私有函數(shù)程序中一行的代碼和注釋不能超過80列。定義指針類型的變量，*應(yīng)放在變量前。源程序中關(guān)系較為緊密的代碼應(yīng)盡可能相鄰。iLength =10;iWidth =5;//矩形的長與寬關(guān)系較密切，放在一起。StrCaption =“Test”;禁止使用TAB鍵，必須使用空格進(jìn)行縮進(jìn)?？s進(jìn)為4個(gè)空格。程序的分界符‘{’和‘}’應(yīng)獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語句左對齊。{}之內(nèi)的代碼塊使用縮進(jìn)規(guī)則對齊。if、else、elseif、for、while、do等語句自占一行，執(zhí)行語句不得緊跟其后。不論執(zhí)行語句有多少都要加{}。if(varible1<varible2){varible1=varible2;}聲明類的時(shí)候，public、protected、private關(guān)鍵字與分界符{}對齊，這些部分的內(nèi)容要進(jìn)行縮進(jìn)。結(jié)構(gòu)型的數(shù)組、多維的數(shù)組如果在定義時(shí)初始化，按照數(shù)組的矩陣結(jié)構(gòu)分行書寫。相關(guān)的賦值語句等號對齊。在switch語句中，每一個(gè)case分支和default要用{}括起來，{}中的內(nèi)容需要縮進(jìn)。不同邏輯程序塊之間要使用空行分隔。一元操作符如“!”、“~”、“++”、“--”、“*”、“&”（地址運(yùn)算符）等前后不加空格?！埃郏荨?、“.”、“->”這類操作符前后不加空格。多元運(yùn)算符和它們的操作數(shù)之間至少需要一個(gè)空格。關(guān)鍵字之后要留空格。（if、for、while等關(guān)鍵字之后應(yīng)留一個(gè)空格再跟左括號‘(’，以突出關(guān)鍵字。）函數(shù)名之后不要留空格。（函數(shù)名后緊跟左括號‘(’，以與關(guān)鍵字區(qū)別。）(’向后緊跟，‘)’、‘,’、‘;’向前緊跟，緊跟處不留空格?！?’之后要留空格?！?’不是行結(jié)束符號時(shí)其后要留空格。長表達(dá)式（超過80列）要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊。函數(shù)聲明時(shí)，類型與名稱不允許分行書寫。注釋一般情況下，源程序有效注釋量必須在20％以上。注釋符與注釋內(nèi)容之間要用一個(gè)空格進(jìn)行分隔。文件頭部必須進(jìn)行注釋，包括：.h文件、.c文件、.cpp文件、.inc文件、.def文件、編譯說明文件.cfg等。函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、訪問和修改的表、修改信息等。包含在{}中代碼塊的結(jié)束處應(yīng)加注釋，便于閱讀。特別是多分支、多重嵌套的條件語句或循環(huán)語句。voidMain（）{if(…){… while(…){…}/*endofwhile(…)*/ //指明該條while語句結(jié)束…}/*endofif(…)*///指明是哪條語句結(jié)束}/*endofvoidmain（）*/ //指明函數(shù)的結(jié)束保證代碼和注釋的一致性。修改代碼同時(shí)修改相應(yīng)的注釋，不再有用的注釋要?jiǎng)h除。注釋應(yīng)與其描述的代碼相近，對代碼的注釋應(yīng)放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。全局變量要有詳細(xì)的注釋，包括對其功能、取值范圍、訪問信息及訪問時(shí)注意事項(xiàng)等的說明。注釋與所描述內(nèi)容進(jìn)行同樣的縮排。對分支語句（條件分支、循環(huán)語句等）必須編寫注釋。盡量避免在注釋中使用縮寫，特別是不常用縮寫。命名規(guī)則標(biāo)識符要采用英文單詞或其組合，便于記憶和閱讀，切忌使用漢語拼音來命名。嚴(yán)格禁止使用連續(xù)的下劃線，下劃線也不能出現(xiàn)在標(biāo)識符頭或結(jié)尾（預(yù)編譯開關(guān)除外）。程序中不要出現(xiàn)僅靠大小寫區(qū)分的相似的標(biāo)識符。用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。宏、常量名都要使用大寫字母,用下劃線‘_’分割單詞。預(yù)編譯開關(guān)的定義使用下劃線‘_’開始。變量名長度應(yīng)小于31個(gè)字符，以保持與ANSIC標(biāo)準(zhǔn)一致。不得取單個(gè)字符（如i、j、k等）作為變量名，但是局部循環(huán)變量除外。程序中局部變量不要與全局變量重名。使用一致的前綴來區(qū)分變量的作用域。g_：全局變量s_：模塊內(nèi)靜態(tài)變量空：局部變量不加范圍前綴使用一致的小寫類型指示符作為前綴來區(qū)分變量的類型。說明：常用變量類型前綴列表如下：i ：intf ：floatd ：doublec ：charuc ：unsignedchar或BYTEl ：longp ：pointerb ：BOOLh ：HANDLEw：unsignedshort或WORDdw ：DWORD或unsignedlonga ：數(shù)組，arrayofTYPEstr ：字符串t ：結(jié)構(gòu)類型完整的變量名應(yīng)由前綴+變量名主體組成，變量名的主體應(yīng)當(dāng)使用“名詞”或者“形容詞＋名詞”，且首字母必須大寫。floatg_fValue;函數(shù)名用大寫字母開頭的單詞組合而成，且應(yīng)當(dāng)使用“動詞”或者“動詞＋名詞”（動賓詞組）。結(jié)構(gòu)名、聯(lián)合名、枚舉名由前綴T_開頭。事件名由前綴EV_開頭。標(biāo)識符前最好不加項(xiàng)目、產(chǎn)品、部門的標(biāo)識。變量常量與類型定義全局變量時(shí)必須仔細(xì)分析，明確其含義、作用、取值范圍及與其它全局變量間的關(guān)系。明確全局變量與操作此全局變量的函數(shù)或過程的關(guān)系。一個(gè)變量有且只有一個(gè)功能，不能把一個(gè)變量用作多種用途。循環(huán)語句與判斷語句中，不允許對其它變量進(jìn)行計(jì)算與賦值。宏定義中如果包含表達(dá)式或變量，表達(dá)式和變量必須用小括號括起來。使用宏定義多行語句時(shí),必須使用{}把這些語句括起來。建議：盡量構(gòu)造僅有一個(gè)模塊或函數(shù)可以修改、創(chuàng)建的全局變量，而其余有關(guān)模塊或函數(shù)只能訪問。對于全局變量通過統(tǒng)一的函數(shù)訪問。盡量使用const說明常量數(shù)據(jù)，對于宏定義的常數(shù)，必須指出其類型。最好不要在語句塊內(nèi)聲明局部變量。結(jié)構(gòu)和聯(lián)合必須被類型化。typedefstruct{characName[NAME_SIZE];WORDwScore;}T_Student;T_Student*ptStudent;建議：使用嚴(yán)格形式定義的、可移植的數(shù)據(jù)類型，盡量不要使用與具體硬件或軟件環(huán)境關(guān)系密切的變量。結(jié)構(gòu)是針對一種事務(wù)的抽象，功能要單一，不要設(shè)計(jì)面面俱到的數(shù)據(jù)結(jié)構(gòu)。不同結(jié)構(gòu)間的關(guān)系要盡量簡單，若兩個(gè)結(jié)構(gòu)間關(guān)系較復(fù)雜、密切，那么應(yīng)合為一個(gè)結(jié)構(gòu)。結(jié)構(gòu)中元素的個(gè)數(shù)應(yīng)適中。若結(jié)構(gòu)中元素個(gè)數(shù)過多可考慮依據(jù)某種原則把元素組成不同的子結(jié)構(gòu)，以減少原結(jié)構(gòu)中元素的個(gè)數(shù)。仔細(xì)設(shè)計(jì)結(jié)構(gòu)中元素的布局與排列順序，使結(jié)構(gòu)容易理解、節(jié)省占用空間，并減少引起誤用現(xiàn)象，對于結(jié)構(gòu)中未用的位明確地給予保留。結(jié)構(gòu)的設(shè)計(jì)要盡量考慮向前兼容和以后的版本升級，并為某些未來可能的應(yīng)用保留余地（如預(yù)留一些空間等）。合理地設(shè)計(jì)數(shù)據(jù)并使用自定義數(shù)據(jù)類型，盡量減少沒有必要的數(shù)據(jù)類型默認(rèn)轉(zhuǎn)換與強(qiáng)制轉(zhuǎn)換。當(dāng)聲明數(shù)據(jù)結(jié)構(gòu)時(shí)，必須考慮機(jī)器的字節(jié)順序、使用的位域及字節(jié)對齊等問題。表達(dá)式與語句在表達(dá)式中使用括號，使表達(dá)式的運(yùn)算順序更清晰。if(((iYear%4==0)&&(iYear%100!=0))||(iYear%400==0))避免表達(dá)式中的附加功能，不要編寫太復(fù)雜的復(fù)合表達(dá)式。不可將浮點(diǎn)變量用“==”或“!=”與任何數(shù)字比較。應(yīng)當(dāng)將指針變量用“==”或“!=”與NULL比較。在switch語句中，每一個(gè)case分支必須使用break結(jié)尾，最后一個(gè)分支必須是default分支。不可在for循環(huán)體內(nèi)修改循環(huán)變量，防止for循環(huán)失去控制。建議：循環(huán)嵌套次數(shù)不大于3次。dowhile語句和while語句僅使用一個(gè)條件。當(dāng)switch語句的分支比較多時(shí)，采用數(shù)據(jù)驅(qū)動方式。如果循環(huán)體內(nèi)存在邏輯判斷，并且循環(huán)次數(shù)很大，宜將邏輯判斷移到循環(huán)體的外面。for語句的循環(huán)控制變量的取值采用“半開半閉區(qū)間”寫法。在進(jìn)行“==”比較時(shí)，將常量或常數(shù)放在“==”號的左邊。參數(shù)如果函數(shù)沒有參數(shù)，則用void填充。voidSetValue(intiWidth,intiHeight);floatGetValue(void);如果參數(shù)是指針，且僅作輸入用，則應(yīng)在類型前加const。（防止該指針在函數(shù)體內(nèi)被意外修改。）當(dāng)結(jié)構(gòu)變量作為參數(shù)時(shí)，應(yīng)傳送結(jié)構(gòu)的指針而不傳送整個(gè)結(jié)構(gòu)體，并且不得修改結(jié)構(gòu)中的元素，用作輸出時(shí)除外。不要省略返回值的類型，如果函數(shù)沒有返回值，那么應(yīng)聲明為void類型。對于有返回值的函數(shù)，每一個(gè)分支都必須有返回值。（為了保證對被調(diào)用函數(shù)返回值的判斷，有返回值的函數(shù)中的每一個(gè)退出點(diǎn)都需要有返回值）對輸入?yún)?shù)的正確性和有效性進(jìn)行檢查。防止將函數(shù)的參數(shù)作為工作變量。voidSumData(intiNum,int*piData,int*piSum){intiCount;intiSumTmp;//存儲“和”的臨時(shí)變量iSumTmp=0;for(iCount=0;iCount<iNum;iCount++){iSumTmp+=piData[iCount];}*piSum=iSumTmp;}反例：voidSumData(intiNum,int*piData,int*piSum){intiCount;*piSum=0;for(iCount=0;iCount<iNum;iCount++){*piSum+=piData[iCount];//piSum成了工作變量，不好。}}必須對所調(diào)用函數(shù)的錯(cuò)誤返回值進(jìn)行處理。（函數(shù)返回錯(cuò)誤，往往是因?yàn)檩斎氲膮?shù)不合法，或者此時(shí)系統(tǒng)已經(jīng)出現(xiàn)了異常。如果不對錯(cuò)誤返回值進(jìn)行必要的處理，會導(dǎo)致錯(cuò)誤的擴(kuò)大，甚至導(dǎo)致系統(tǒng)的崩潰。）可靠性在程序編制之前，必須了解編譯系統(tǒng)的內(nèi)存分配方式，特別是編譯系統(tǒng)對不同類型的變量的內(nèi)存分配規(guī)則，如局部變量在何處分配、靜態(tài)變量在何處分配等。防止內(nèi)存操作越界。必須對動態(tài)申請的內(nèi)存做有效性檢查，并進(jìn)行初始化；動態(tài)內(nèi)存的釋放必須和分配成對以防止內(nèi)存泄漏，釋放后內(nèi)存指針置為NULL。變量在使用前應(yīng)初始化，防止未經(jīng)初始化的變量被引用。指針類型變量必須初始化為NULL。指針不要進(jìn)行復(fù)雜的邏輯或算術(shù)操作。如果指針類型明確不會改變，應(yīng)該強(qiáng)制為const類型的指針，以加強(qiáng)編譯器的檢查。減少指針和數(shù)據(jù)類型的強(qiáng)制類型轉(zhuǎn)化。移位操作一定要確定類型。對變量進(jìn)行賦值時(shí)，必須對其值進(jìn)行合法性檢查，防止越界等現(xiàn)象發(fā)生。類中的屬性應(yīng)聲明為private，用公有的函數(shù)訪問。在編寫派生類的賦值函數(shù)時(shí)，注意不要忘記對基類的成員變量重新賦值。構(gòu)造函數(shù)應(yīng)完成簡單有效的功能，不應(yīng)完成復(fù)雜的運(yùn)算和大量的內(nèi)存管理。不要在棧中分配類的實(shí)例，也不要生成全局類實(shí)例。正確處理拷貝構(gòu)造函數(shù)與賦值函數(shù)。過程/函數(shù)中申請的（為打開文件而使用的）文件句柄，在過程/函數(shù)退出之前要關(guān)閉，除非要把這個(gè)句柄傳遞給其它函數(shù)使用?？蓽y試性在同一項(xiàng)目組或產(chǎn)品組內(nèi)，為準(zhǔn)備集成測試和系統(tǒng)聯(lián)調(diào)，要有一套統(tǒng)一的調(diào)測開關(guān)及相應(yīng)信息輸出函數(shù)，并且要有詳細(xì)的說明。統(tǒng)一的調(diào)試接口和輸出函數(shù)由模塊設(shè)計(jì)和測試人員根據(jù)項(xiàng)目特性統(tǒng)一制訂，由項(xiàng)目系統(tǒng)人員統(tǒng)一納入系統(tǒng)設(shè)計(jì)中。在同一個(gè)項(xiàng)目組或產(chǎn)品組內(nèi)，調(diào)測打印出的信息串要有統(tǒng)一的格式。信息串中應(yīng)當(dāng)包含所在的模塊名（或源文件名）及行號等信息。在編寫代碼之前，應(yīng)預(yù)先設(shè)計(jì)好程序調(diào)試與測試的方法和手段，并設(shè)計(jì)好各種調(diào)測開關(guān)及相應(yīng)測試代碼（如打印函數(shù)等）。斷言與錯(cuò)誤處理整個(gè)軟件系統(tǒng)應(yīng)該采用統(tǒng)一的斷言。如果系統(tǒng)不提供斷言，則應(yīng)該自己構(gòu)造一個(gè)統(tǒng)一的斷言供編程時(shí)使用。