編程代碼規(guī)范

1、1. 臨時變量命名規(guī)則：首字母小寫，name1Name2.2. 常量命名規(guī)則：大寫，NAME13. 函數(shù)命名規(guī)則：首字母大寫，Name1Name2().4. 注釋規(guī)范標準的函數(shù)注釋格式；/=/函數(shù)名： /作者： /日期： /功能： /輸入?yún)?shù)：/返回值： /修改記錄：/=示例：/=/函數(shù)名： RecordIsExist/作者： jiangjingsong /日期： 2004-02-22/功能： 判斷當前待插入或更新的記錄在原表中是否已經(jīng)存在/輸入?yún)?shù)：bm (表名） 待查找的 表的名字/ zdm (字段名）在表中待查找的字段/ zdz(字段值） 需要比較的字段的值/返回值： 類型（boolea

2、n)/ 返回true表示當前表中存在一條跟待插入的記錄一樣的記錄；/ 返回false表示當前待插入的記錄在表中不存在。/修改記錄：/=我做C語言底層開發(fā)，積累了一些代碼書寫的經(jīng)驗供大家參考：1.C語言書寫規(guī)范1.1符號命名規(guī)則1.1.1符號名包括模塊名、常量名、標號名、子程序名等。這些名字應該能反映它所代表的實際東西，具有一定的意義，使其能夠見名知義，有助于對程序功能的理解。命名采用匈牙利命名法。規(guī)則如下：(1)所有宏定義、枚舉常數(shù)和const變量，用大寫字母命名。在復合詞里用下劃線隔開每個詞。(2)復合詞中每個單詞的第一個字母大寫。除了規(guī)則5.1.1.1以外，避免使用下劃線。(3)類、類型定

3、義和枚舉型名的第一個字母大寫。(4)函數(shù)名是復合詞的，第一個詞采用全部小寫，隨后每個單詞采用第一個字母大寫，其它字母小寫方式；如果是單個詞的，采用全部小寫方式。(5)循環(huán)變量可采用i, j, k等，不受上述規(guī)則限制。(6) 類的成員變量應采用m_開頭。(7) 全局變量詞頭為g_ 。(8) 臨時變量詞頭為tmp_ 。(9) 對結(jié)構體內(nèi)的變量命名, 遵循變量的具體含義命名原則(10)用小寫字母的前綴表示變量的類型，前綴的下一個字母用大寫。表 1詞 頭 類 型 詞 頭 類 型ch char l longi integer u unsignedb boolean p pointerf float lp

4、 long pointerd double s stringst structure sz ASCII stringby byte n short intH handle x,y 分別為x,y坐標dw DWORD fn function表 2詞 頭 變 量 名 詞 頭 變 量 名task task sig signalsb binary semaphores wd watchdogsm mutual exclusionsemaphores tm timersc counting semaphores msg messagepipe pipe例：#define ARRAY_SIZE 24 /*規(guī)

5、則5.1.1.1*/int g_iFlag;class MyClass /*規(guī)則5.1.1.3*/;void someFunc( ) /*規(guī)則5.1.1.2和5.1.1.4*/.2.Q/ECC/BJ 0102001int nArrayARRAY_SIZE;unsigned char uchByte;char szName ;char *pszName = szName;(11)有些詞頭（如p和u）可以和其它詞頭組合。例：WDOG_ID wdId;WDOG_ID g_wdId; /*全局watchdog Id，故以g_開頭*/1.1.2名字的長度一般不要過長或過短。過長的名字會增加工作量，使程序

6、邏輯流程變得模糊；過短的名字無法表達符號的實際意義。約定長度范圍：3-31；1.2數(shù)據(jù)和函數(shù)說明1.2.1數(shù)據(jù)說明次序應當規(guī)范化，使數(shù)據(jù)屬性容易查找，也有利于測試、排錯和維護。說明的先后次序應固定，應按邏輯功能排序，邏輯功能塊內(nèi)建議采用下列順序：整型說明、實型說明、字符說明、邏輯量說明。1.2.2如果設計了一個復雜的數(shù)據(jù)結(jié)構，應當通過注釋對其變量的含義、用途進行說明。1.2.3在函數(shù)的聲明中使用異常聲明。如：void f() throw(toobig, toosmall, divzero);在聲明一個函數(shù)時，將它所拋出的異常列出，便于函數(shù)的使用者了解可能會發(fā)生哪些異常。1.3 程序注釋1.3.

7、1程序注釋是程序員與日后的程序讀者之間通信的重要手段之一，注釋分為文件注釋、函數(shù)注釋和功能注釋。1.3.2正規(guī)程序的注釋應注意：注釋行的數(shù)量占到整個源程序的1/3到1/2。1.3.3文件注釋位于整個源程序的最開始部分，注釋后空兩行開始程序正文。它包括：程序標題。目的、功能說明。文件作者、最后修改日期等說明。例：./*（空一行）標題: Demo.c功能: 測試VxWorks的各種系統(tǒng)調(diào)用.說明:該程序測試各種VxWorks的系統(tǒng)調(diào)用函數(shù)。包括任務（taks）的創(chuàng)建、掛起及任務間通過信號燈實現(xiàn)同步，通過消息隊列進行通訊。程序創(chuàng)建了兩個任務：一個高優(yōu)先級的任務和一個低優(yōu)先級的任務。兩個任務間通過一個

8、二進制的信號燈進行同步，通過消息隊列進行通訊。當前版本： x.x修改信息： 2000.06.05 John， Initial Version2000.07.05 Tom， Bug xxxx fixed*/(空2行，開始程序正文)1.3.4 函數(shù)注釋通常置于每函數(shù)或過程的開頭部分，它應當給出函數(shù)或過程的整體說明對于理解程序本身具有引導作用。一般包括如下條目：模塊標題。有關本模塊功能和目的的說明。調(diào)用格式接口說明：包括輸入、輸出、返回值、異常。算法。如果模塊中采用了一些復雜的算法。例：file:/（注釋開頭應和上一函數(shù)空兩行）（注釋開頭與上一函數(shù)最后一行間隔兩行）/*標題：assignmentCo

9、mplete功能：BSC=MSC消息生成函數(shù)，生成assignment_complete指配完成消息(BSMAP消息) .格式：int assignmentComplete(int iCellId, int iServiceChannnelNum, char *pszMSGData) throw(exception1, exception2)輸入：int iCellId: MS所在的小區(qū)識別iCellId取值：0x00-0xff .4.Q/ECC/BJ 0102001int iServiceChannnelNum：MS所占的業(yè)務信道號碼輸出：char * pszMSGData：指配完成消息數(shù)據(jù)

10、返回值: 0x00正常異常：exception1異常情況1, exception2異常情況2*/( 注釋后直接開始程序正文，不空行。)1.3.5功能性注釋嵌在源程序體中，用于描述其后的語句或程序段做什么工作，也就是解釋下面要做什么，或是執(zhí)行了下面的語句會怎么樣。而不要解釋下面怎么做，因為解釋怎么做常常與程序本身是重復的。例：/*把 amount 加到 total中*/total = amount + total;這樣的注釋僅僅是重復了下面的程序，對于理解它的工作并沒有什么作用。而下面的注釋，有助于讀者理解。/*將每月的銷售額amount加到年銷售額total中*/total = amount

11、+ total;1.4 函數(shù)編寫應盡可能短小精悍，一般不超過兩屏，以便于調(diào)試和理解。1.5語句結(jié)構為保證語句結(jié)構的清晰和程序的可讀性，在編寫軟件程序時應注意以下幾個方面的問題：在一行內(nèi)只寫一條語句，并采用空格、空行和移行保證清楚的視覺效果。每一個嵌套的函數(shù)塊，使用一個TAB縮進（可以設定為4個空格），大括號必須放在條件語句的下一行，單獨成一行，便于匹對：如，有一段程序如下：for(i=1;in-1;i+) t=1; for(j=i+1;jn;j+)if(ajat ) t=j; if(t!=i )work=at;at=aI;aI=work;應寫為for( i=1; in-1; i+)t=1;fo

12、r(j = i+1; jn; j+)if(aib)?a:b;不要使用空的if else 語句。如if(cMychar = A)if(cMychar = Z)printf(“This is a letter n”);elseprintf(“This is not a letter n”);else到底是否定哪個if容易引起誤解?？赏ㄟ^加避免誤解。盡量減少使用“否定”條件的條件語句。如：把 if( !( (cMychar9) ) )改為if( (cMychar=0) & (cMychar 1000#pragma once#endif / _MSC_VER 1000#include / 引用標準庫的

13、頭文件, 必須使用#include “myheader.h” / 引用非標準庫的頭文件，必須使用namespace tq / 命名空間class CBox / 類結(jié)構聲明;void Function1(); / 全局函數(shù)聲明#endif / end of define _GRAPHICS_H_【規(guī)則1-1-3】防止頭文件重復應用預處理塊為了防止頭文件被重復引用，應當用ifndef/define/endif結(jié)構產(chǎn)生預處理塊?！疽?guī)則1-1-4】標準庫的頭文件的引用用 #include 格式來引用標準庫的頭文件（編譯器將從標準庫目錄開始搜索）。【規(guī)則1-1-5】非標準庫頭文件的引用用 #includ

14、e “filename.h” 格式來引用非標準庫的頭文件（編譯器將從用戶的工作目錄開始搜索）。【規(guī)則1-1-6】不允許使用全局類類型變量盡量不要在頭文件中出現(xiàn)象extern CClassName obj 這類聲明，以防止全局對象初始化時，多個類對象的構造函數(shù)和析購函數(shù)的調(diào)用順序混亂?？捎萌趾瘮?shù)代替全局類類型變量。【規(guī)則1-1-7】發(fā)布的頭文件應通過完整性檢查發(fā)布的頭文件（例如： header.h）, 應用如下的test.cpp編譯通過，以檢查頭文件相應的完整性與自包含性。test.cpp文件的內(nèi)容如下：#include header.h / 檢查頭文件的完整性#include header.

15、h / 檢查頭文件的是否被重復引用【建議1-1-1】頭文件中只存放“聲明”而不存放“定義（實現(xiàn)代碼）”在C+ 語法中，類的成員函數(shù)可以在聲明的同時被定義，并且自動成為內(nèi)聯(lián)函數(shù)。這雖然會帶來書寫上的方便，但卻造成了風格不一致，弊大于利。建議將成員函數(shù)的定義與聲明分開，不論該函數(shù)體有多么小。如果想通過內(nèi)聯(lián)函數(shù)提高代碼效率，可在定義文件中相應的成員函數(shù)實現(xiàn)代碼前加上關鍵字inline（參見規(guī)則6-5-1）。第2節(jié) 定義文件(.CPP/.C)【規(guī)則1-2-1】定義文件的組成（1） 定義文件開頭處的版權聲明（參見示例1-1-1）。（2） 對一些頭文件的引用。（3） 程序的實現(xiàn)體（包括數(shù)據(jù)和代碼）。假設定

16、義文件的名稱為 graphics.cpp，定義文件的結(jié)構參見示例1-2-1?！臼纠?-2-1】/ 版權和版本聲明見示例1-1，此處省略。#include “graphics.h” / 引用頭文件/ 類成員函數(shù)的實現(xiàn)體void CBox:Draw()/ 全局函數(shù)的實現(xiàn)體void Function1()第3節(jié) 文件的組織【規(guī)則1-3-1】文件應與類設計相對應將一個類分解給2個文件存儲。一個是頭文件(.h)，用于聲明類的成員變量和成員函數(shù)；另一是定義文件(.cpp/.c)，用于類的成員變量的初始化和成員函數(shù)的具體實現(xiàn)。【規(guī)則1-3-2】不要將多個類的設計放在同一個“頭文件/定義文件”中接口類不必遵守

17、該規(guī)則?！窘ㄗh1-3-1】目錄結(jié)構需要公開的頭文件（如接口）保存于Include目錄或Inc，將不需要公開的頭文件和定義文件保存于Source目錄或Src?！窘ㄗh1-3-2】不要將一個類的設計放在一個頭文件和多個定義文件 如果出現(xiàn)定義文件太大，不得不分解為多個定義文件的情況，應考慮類的設計是否恰當。第二部分 排版第1節(jié) 空行【規(guī)則2-1-1】類聲明、函數(shù)定義之后空行在每個類聲明之后、每個函數(shù)定義結(jié)束之后都要加空行。參見示例2-1-1（a）【規(guī)則2-1-2】函數(shù)體內(nèi)，邏輯中斷空行在一個函數(shù)體內(nèi)，邏揖上密切相關的語句之間不加空行，其它地方應加空行分隔。參見示例2-1-1（b ）【示例2-1-1】(

18、a-b)/ 空行void Function1() / 空行void Function2() / 空行void Function3() / 空行while (condition) statement1; / 空行 if (condition) statement2; else statement3; / 空行 statement4;示例2-1-1(a) 函數(shù)之間的空行 示例2-1-1(b) 函數(shù)內(nèi)部的空行第2節(jié) 代碼行【規(guī)則2-2-1】if、for、while、do等語句自占一行執(zhí)行語句不得緊跟其后。不論執(zhí)行語句有多少都要加。這樣可以防止書寫失誤。示例2-2-1（a）為風格良好的代碼行，示例2-

19、2-1（b）為風格不良的代碼行?！臼纠?-2-1】(a-b)int nWidth; / 寬度int nHeight; / 高度int nDepth; / 深度int nWidth, nHeight, nDepth; / 寬度高度深度x = a + b;y = c + d;z = e + f;X a + b; y = c + d; z = e + f;if (nWidth nHeight)dosomething();if (nWidth =”、“=”、“+”、“*”、“%”、“&”、“|”、“”這類操作符前后不加空格?！窘ㄗh2-3-1】關鍵字之后要留空格const、virtual、inline、

20、case 等關鍵字之后至少要留一個空格，否則無法辨析關鍵字。if、for、while等關鍵字之后應留一個空格再跟左括號（，以突出關鍵字。【建議2-3-2】函數(shù)名之后不要留空格緊跟左括號（，以與關鍵字區(qū)別。【建議2-3-3】（向后緊跟不留空格;）、，、;向前緊跟不留空格緊跟處不留空格?！窘ㄗh2-3-4】較長表達式可以適當?shù)厝サ粢恍┛崭駥τ诒磉_式比較長的for語句和if語句，為了緊湊起見可以適當?shù)厝サ粢恍┛崭瘢鏵or (i=0; i10; i+)和if (a=b) & (c= 2000) / 良好的風格if(nYear=2000) / 不良的風格if (a=b) & (c=b&c=d) / 不良

21、的風格for (i=0; i10; i+) / 良好的風格for(i=0;i10;i+) / 不良的風格for (i = 0; i 10; i +) / 過多的空格x = a b ? a : b; / 良好的風格x=aFunction(); / 不要寫成 b - Function();第4節(jié) 對齊【規(guī)則2-4-1】分界符對齊程序的分界符和應獨占一行并且位于同一列，同時與引用它們的語句左對齊?！疽?guī)則2-4-2】分界符內(nèi)的代碼塊對齊 之內(nèi)的代碼塊在右邊數(shù)格處左對齊。示例2-4-1（a）為風格良好的對齊，示例2-4-1（b）為風格不良的對齊?！臼纠?-4-1】（a-b）void Function(i

22、nt x) / program codevoid Function(int x) / program codeif (condition) / program codeelse / program codeif (condition) / program codeelse / program codefor (initialization; condition; update) / program codefor (initialization; condition; update) / program codeWhile (condition) / program codewhile (co

23、ndition) / program code如果出現(xiàn)嵌套的，則使用縮進對齊，如： 示例2-4-1(a) 風格良好的對齊 示例2-4-1(b) 風格不良的對齊第5節(jié) 長行拆分【規(guī)則2-5-1】拆分方法長表達式要在低優(yōu)先級操作符處拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要進行適當?shù)目s進，使排版整齊，語句可讀。【示例2-5-1】if (very_longer_variable1 = very_longer_variable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variable5

24、Draw(); / 類的成員函數(shù)pBitmap-GetWidth();【規(guī)則3-1-7】用正確的反義詞組用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)等。例如：int nMinValue;int nMaxValue;void SetValue();int GetValue();【規(guī)則3-1-8】盡量避免名字中出現(xiàn)數(shù)字編號如Value1,Value2等，除非邏輯上的確需要編號。這是為了防止程序員偷懶，不肯為命名動腦筋而導致產(chǎn)生無意義的名字（因為用數(shù)字編號最省事）。【規(guī)則3-1-9】自定義類型名自定義類型是指非C+標準的內(nèi)置數(shù)據(jù)類型，包括：類類型、結(jié)構類型、聯(lián)合類型、枚舉類型以及由type

25、def定義的類型。（1）類類型名用“C”加大寫字母開頭的單詞組合而成；例如： class CNode; / 類名 接口類類型名用“I”加大寫字母開頭的單詞組合而成；例如： class IRole; / 接口類名 模板類類型名用“T”加大寫字母開頭的單詞組合而成。例如： class TEncryptor; / 模板類名（2）結(jié)構, 聯(lián)合，枚舉，typedef定義類型名用全部大寫字母的單詞組合而成，單詞間加下劃線連接。例如： struct NODE_INFO; / 結(jié)構名struct PLAYER_INFO;struct POINTint x, y;POINT(int _x = 0, int _y

26、 = 0) : x(_x), y(_y) （3）集合型數(shù)據(jù)類型的重定義typedef std:vector USER_VEC;typedef std:list USER_LST;typedef std:deque USER_DEQ;typedef std:queue USER_QUE;typedef std:stack USER_STK;typedef std:set ID_SET;typedef std:map USER_MAP;typedef std:multimap USER_MMAP;typedef std:hash_map USER_HMAP;typedef std:pair USE

27、R_PAR;編程規(guī)范1.基本要求1.1 程序結(jié)構清析，簡單易懂，單個函數(shù)的程序行數(shù)不得超過100行。1.2 打算干什么，要簡單，直接了當，代碼精簡，避免垃圾程序。1.3 盡量使用標準庫函數(shù)和公共函數(shù)。1.4 不要隨意定義全局變量，盡量使用局部變量。1.5 使用括號以避免二義性。2.可讀性要求2.1 可讀性第一，效率第二。2.2 保持注釋與代碼完全一致。2.3 每個源程序文件，都有文件頭說明，說明規(guī)格見規(guī)范。2.4 每個函數(shù)，都有函數(shù)頭說明，說明規(guī)格見規(guī)范。2.5 主要變量（結(jié)構、聯(lián)合、類或?qū)ο螅┒x或引用時，注釋能反映其含義。2.7 常量定義（DEFINE）有相應說明。2.8 處理過程的每個階

28、段都有相關注釋說明。2.9 在典型算法前都有注釋。2.10 利用縮進來顯示程序的邏輯結(jié)構，縮進量一致并以Tab鍵為單位，定義Tab為 6個字節(jié)。2.11 循環(huán)、分支層次不要超過五層。2.12 注釋可以與語句在同一行，也可以在上行。2.13 空行和空白字符也是一種特殊注釋。2.14 一目了然的語句不加注釋。2.15 注釋的作用范圍可以為：定義、引用、條件分支以及一段代碼。2.16 注釋行數(shù)（不包括程序頭和函數(shù)頭說明部份）應占總行數(shù)的 1/5 到 1/3 。3. 結(jié)構化要求3.1 禁止出現(xiàn)兩條等價的支路。3.2 禁止GOTO語句。3.3 用 IF 語句來強調(diào)只執(zhí)行兩組語句中的一組。禁止 ELSE

29、GOTO 和 ELSE RETURN。3.4 用 CASE 實現(xiàn)多路分支。3.5 避免從循環(huán)引出多個出口。3.6 函數(shù)只有一個出口。3.7 不使用條件賦值語句。3.8 避免不必要的分支。3.9 不要輕易用條件分支去替換邏輯表達式。4. 正確性與容錯性要求4.1 程序首先是正確，其次是優(yōu)美4.2 無法證明你的程序沒有錯誤，因此在編寫完一段程序后，應先回頭檢查。4.3 改一個錯誤時可能產(chǎn)生新的錯誤，因此在修改前首先考慮對其它程序的影響。4.4 所有變量在調(diào)用前必須被初始化。4.5 對所有的用戶輸入，必須進行合法性檢查。4.6 不要比較浮點數(shù)的相等，如： 10.0 * 0.1 = 1.0 ， 不可靠4.7 程序與環(huán)境或狀態(tài)發(fā)生關系時，必須主動去處理發(fā)生的意外事件，如文件能否邏輯鎖定、打印機是否聯(lián)機等。4.8 單元測試也是編程的一部份，提交聯(lián)調(diào)測試的程序必須通過單元測試。5. 可重用性要求5.1 重復使用的完成相對獨立功能的算法或代碼應抽象為公共控件或類。5.2 公共控件或類應考慮OO思想，減少外界聯(lián)系，考慮獨立性或封裝性。5.3 公共控件或類應建立使用模板。 附：C 編程規(guī)范,delph