編程規(guī)范和技巧——編寫高質量的CC++程序

1、編程規(guī)范和技巧 編寫高質量的C/C+程序一定要編寫高質量代碼！高質量代碼提高編程效率減少調試時間提高人品：代碼是寫給他人用的！養(yǎng)成好習慣從點點滴滴做起不要光看不做程序員的境界大學計算機教育的失誤：程序質量低下什么是編程老手：能夠長期穩(wěn)定地編寫出高質量程序的程序員什么是編程高手：能夠長期穩(wěn)定地編寫出高難度、高質量程序的程序員編程風格世上不存在最好的編程風格一切因需求而定團隊開發(fā)講究風格一致如果制定了大家認可的編程風格，那么所有組員都要遵守若某種編程風格比較合你的工作，那么就采用它，不要只看不做：養(yǎng)成習慣！一流代碼的特性魯棒 - Solid and Robust Code簡潔 - Maintain

2、able and Simple Code高效 - Fast Code簡短 - Small Code共享 - Re-usable Code可測試 - Testable Code可移植 - Portable Code一流代碼關于代碼風格問題代碼風格（Coding Style）是一種習慣現(xiàn)在許多大公司都對員工書寫代碼制定了規(guī)范開發(fā)大項目時由項目管理者制定代碼規(guī)范程序風格的重要構成因素程序版式命名規(guī)則函數(shù)設計原則其他表達式規(guī)則與零比較常量規(guī)則動態(tài)數(shù)組內存管理程序版式程序版式程序員的書法比書法好學得多，基本不需要特別練習但是壞習慣一旦養(yǎng)成，就像書法一樣難以改變不影響程序的功能，但影響程序的可讀性追求清晰

3、、整潔、美觀、一目了然容易閱讀，容易測試程序版式不良的風格int isprime(int n)int k,i;if (n = 1) return 0;k=sqrt(double)n); for (i=2;i=k;i+)if(n%i=0) return 0;return 1;#include #include main()int i;for (i=2;i100;i+)if(isprime(i)printf(%dt,i); 程序版式良好的風格int isprime(int n) int k, i; if (n = 1) return 0; k = (int)sqrt(double)n); for

4、(i=2; i=k; i+) if (n % i = 0) return 0; return 1;#include #include main() int i; for (i=2; i 前后不加空格對表達式較長的for和if語句，為了緊湊可在適當?shù)胤饺サ粢恍┛崭駀or (i=0; ic) & (b+ca) & (c+ab)void Func1(int x, int y, int z); / 良好的風格void Func1 (int x,int y,int z); / 不良的風格printf(%d%d%d, a, b, c); / 良好的風格printf(%d%d%d,a,b,c); / 不良的

5、風格if (year = 2000) / 良好的風格if(year=2000) / 不良的風格if (a=b) & (c=b&c=d) / 不良的風格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();程序版式程序版式代碼行一行只寫一條語句，這樣方便測試一行只寫一個變量，這樣方便寫注釋int width; /寬度int height; /高度int depth; /深度

6、盡可能在定義變量的同時，初始化該變量int sum = 0;if、for、while、do等語句各占一行，執(zhí)行語句無論有幾條都用和將其包含在內，這樣便于維護if (width height) DoSomething();/空行OtherThing();int width;/ 寬度int height;/ 高度int depth;/ 深度int width, height, depth; /寬度高度深度x = a + b;y = c + d;z = e + f;x = a + b; y = c + d; z = e + f;if (width height) dosomething();if (

7、width = veryLongVar2) &(veryLongVar3 = veryLongVar4) DoSomething();double FunctionName(double variablename1, double variablename2);for (very_longer_initialization; very_longer_condition; very_longer_update) DoSomething(); 程序版式修飾符*和&的位置有爭議從語義上講，靠近數(shù)據(jù)類型更直觀，但對多個變量聲明時容易引起誤解int* x, y;提倡靠近變量名int *x, y;注釋規(guī)范

8、注釋（Comments）的重要性寫注釋給誰看？在哪些地方寫注釋？怎樣寫注釋？注釋的風格寫注釋時的注意事項可靈活運用的一些規(guī)則注釋規(guī)范注釋的重要性注釋對于程序猶如眼睛對于人的重要性一樣沒有注釋的程序對于讀者好比眼前一團漆黑，跟拿到一個可執(zhí)行程序別無二致不規(guī)范的注釋和好幾千度的近視眼沒什么區(qū)別代碼本身體現(xiàn)不出價值開發(fā)程序的思維才能使其變得有價值這種思維的具體體現(xiàn)就是在于注釋和規(guī)范的代碼本身注釋規(guī)范寫注釋給誰看？給自己看，使自己的設計思路得以連貫給繼任者看，使其能夠接替自己的工作注釋規(guī)范寫注釋的最重要的功效在于傳承要站在繼任者的角度寫簡單明了、準確易懂、防止二義性讓繼任者可以輕松閱讀、復用、修改自己

9、的代碼讓繼任者輕松辨別出哪些使自己寫的，哪些是別人寫的注釋規(guī)范不好的注釋i = i + 1; /i加1return -1; /返回-1free(p); /釋放p所指的內存fclose(fin); /關閉文件/*/*功能描述： 本函數(shù)用于實現(xiàn)xxx功能，目的是： */ /*入口參數(shù)： 參數(shù)p，表示指向結構體的指針 */ /*出口參數(shù)： 參數(shù)xx，表示 */ /*返回值： 返回xx值，當返回xx值時，表示 */*/注釋規(guī)范不好的注釋不但白寫，還擾亂了讀者的視線/*以二進制只讀方式打開文件并判斷打開是否成功*/if (fin = fopen(cat.pic,rb) = NULL) puts(打開文件

10、cat.pic失敗);/*如果打開失敗，則顯示錯誤信息*/ return -1; /*返回-1*/*從圖像的第1行到第400行循環(huán)*/for (i=0; i400; i+) /*從圖像的第1列到第400列循環(huán)*/ for (j=0; j400; j+) /*按照公式Y = 0.299*R+0.587*G+0.114*B計算灰度值*/ y = (299 * r + 587 * g + 114 * b) / 1000; fclose(fin); /*關閉文件*/注釋規(guī)范好的注釋（尤其是算法注釋）是對設計思想的精確表述和清晰展現(xiàn)，能揭示代碼背后隱藏的重要信息/*打開輸入文件后判斷文件長度是否符合格式

11、要求*/if (fin = fopen(cat.pic,rb) = NULL) puts(打開文件cat.pic失敗); return -1; /* * 下面是圖像轉換的算法實現(xiàn)。彩色圖像到灰度圖像的轉換主要利用RGB顏色空間到 * YUV顏色空間的變換公式來取得灰度值，公式為Y = 0.299*R+0.587*G+0.114*B */for (i=0; i400; i+) for (j=0; j400; j+) y = (299 * r + 587 * g + 114 * b) / 1000; fclose(fin); 注釋規(guī)范在哪些地方寫注釋？在重要的文件首部文件名 + 功能說明 + 作者

12、 + 版本 + 版權聲明 + 日期在用戶自定義函數(shù)前對函數(shù)接口進行說明函數(shù)功能 + 入口參數(shù) +出口參數(shù) + 返回值 （包括出錯處理）在一些重要的語句塊上方對代碼的功能、原理進行解釋說明在一些重要的語句行右方定義一些非通用的變量函數(shù)調用較長的、多重嵌套的語句塊結束處在修改的代碼行旁邊加注釋注釋規(guī)范函數(shù)的注釋風格C風格/*/*功能描述： 本函數(shù)用于實現(xiàn)xxx功能，目的是： */ /*入口參數(shù)： 參數(shù)xx，表示 */ /*出口參數(shù)： 參數(shù)xx，表示 */ /*返回值： 返回xx值，當返回xx值時，表示 */*/* 功能描述： 本函數(shù)用于實現(xiàn)xxx功能，目的是： 入口參數(shù)： 參數(shù)xx，表示 出口參數(shù)

13、： 參數(shù)xx，表示 返回值： 返回xx值，當返回xx值時，表示 */C+風格/功能描述： 本函數(shù)用于實現(xiàn)xxx功能，目的是： /入口參數(shù)： 參數(shù)xx，表示 /出口參數(shù)： 參數(shù)xx，表示 /返回值： 返回xx值，當返回xx值時，表示 /注釋規(guī)范一塊語句的注釋風格/* *C風格 */C風格 /*/*下面代碼是用來接收網(wǎng)絡數(shù)據(jù)，其原理為*/* */*/ Visual C+風格 /注釋規(guī)范一行語句的注釋風格/*C風格*/Visual C+風格i = j + 1;/代碼行右方的注釋/代碼行之上的注釋i = j + 1;例子ResetSrollInfo(g_hwndThumb);/初始化滾動條位置for循

14、環(huán)while循環(huán) if() /if結束/while結束/for結束注釋規(guī)范寫注釋時的注意事項注釋不是白話文翻譯，不要鸚鵡學舌注釋不是教科書，不要把別人當成初學者注釋不是標準庫函數(shù)參考手冊注釋不是越多越好，不好的注釋等于垃圾不寫做了什么，寫想做什么邊寫代碼邊注釋修改代碼同時修改注釋注釋規(guī)范可靈活運用的一些規(guī)則注釋可長可短，但應畫龍點睛，重點加在語義轉折處簡單的函數(shù)可以用一句話簡單說明/兩數(shù)交換void Swap(int *x, int *y)內部使用的函數(shù)可以簡單注釋，供別人使用的函數(shù)必須嚴格注釋，特別是入口參數(shù)和出口參數(shù)Readme的書寫內容主要用來記錄日期、創(chuàng)建者、內容等每次重大功能的添加、

15、修改具體格式：日期TAB創(chuàng)建者TAB內容日期:2003.1.21創(chuàng)建者:XXX內容:實例工程日期TAB修改的文件名TAB修改的功能對修改后的功能和原理的說明日期TAB修改的文件名TAB修改的功能對修改后的功能和原理的說明類的版式“以數(shù)據(jù)為中心”的版式private類型的數(shù)據(jù)寫在前面，public類型的數(shù)據(jù)寫在后面關注類的內部結構“以行為為中心”的版式public類型的數(shù)據(jù)寫在前面， private類型的數(shù)據(jù)寫在后面關注的是類應該提供什么樣的接口（或服務）提倡后者因為用戶最關心的是接口標識符命名規(guī)則按照執(zhí)行級別分為：共性規(guī)則必須執(zhí)行簡化規(guī)則建議采用可選規(guī)則靈活運用標識符命名的共性規(guī)則直觀可以拼讀

16、，見名知意，不必解碼最好采用英文單詞或其組合，切忌用漢語拼音盡量避免出現(xiàn)數(shù)字編號不要出現(xiàn)僅靠大小寫區(qū)分的相似的標識符不要出現(xiàn)名字完全相同的局部變量和全局變量用正確的反義詞組命名具有互斥意義的變量或相反動作的函數(shù)int minValue;int maxValue;int GetValue();int SetValue();標識符命名的共性規(guī)則盡量與所采用的操作系統(tǒng)或開發(fā)工具的風格保持一致在Linux/Unix平臺習慣用“小寫加下劃線”function_name variable_NameWindows風格大小寫混排的單詞組合而成 FunctionName variableNameWindows應

17、用程序命名規(guī)則Microsoft公司的Hungarian Notation主要思想在變量和函數(shù)名前加上前綴，用于標識變量的數(shù)據(jù)類型限定范圍的前綴 + 數(shù)據(jù)類型前綴 + 有意義的英文單詞限定范圍的前綴靜態(tài)變量前加前綴s_ ，表示static全局變量前加前綴g_ ，表示global類內的成員函數(shù)m_默認情況為局部變量數(shù)據(jù)類型前綴ch 字符變量前綴i 整型變量前綴f 實型變量前綴p 指針變量前綴Windows應用程序命名規(guī)則缺點煩瑣例如int i, j, k; float x, y, z;若采用匈牙利命名規(guī)則，則應寫成int iI, iJ, ik; /前綴i表示int類型float fX, fY,

18、fZ; /前綴f表示float類型簡化的Windows應用程序命名規(guī)則變量名形式小寫字母開頭“名詞”或者“形容詞+名詞”如oldValue, newValue等函數(shù)名形式大寫字母開頭“動詞”或者“動詞+名詞”（動賓詞組）如GetValue(), SetValue()等 宏和const常量全用大寫字母，并用下劃線分割單詞#define ARRAY_LEN 10const int MAX_LEN = 100;靈活運用的命名規(guī)則限定范圍的前綴與數(shù)據(jù)類型前綴可要可不要無特殊意義的循環(huán)變量可以直接定義成i,j,k等單字母變量表達式規(guī)則盡量簡單，不要太復雜不要多用途a = i+ + i+ + i+;pri

19、ntf(%d, %d, %d, i+, i+, i+);不要與數(shù)學表達式混淆if (abc) 不表示 if (ab)&(b= -EPS) & (x = EPS)if (fabs(x) = EPS)與零比較的規(guī)則指針變量與零比較不應寫成if (p = 0) /容易誤解為整型變量if (p != 0)if (p) /容易誤解為布爾變量if (!p)應寫成if (p = NULL) /強調p是指針變量if (p != NULL)常量規(guī)則盡量使用含義直觀的常量來表示多次出現(xiàn)的數(shù)字或者字符串#define PI 3.14159const float PI=3.14159;C+中用const常量完全取代宏

20、常量需要對外公開的常量集中放在一個公共的頭文件中，不需要對外公開的常量放在定義文件的頭部常量規(guī)則怎樣建立在類中恒定，且僅在類中有效的常量？#define定義的宏常量是全局的const數(shù)據(jù)成員可以嗎？常量規(guī)則class A const int SIZE = 100;/不能在類聲明中初始化const數(shù)據(jù)成員 int arraySIZE; /類的對象未被創(chuàng)建時，SIZE值未知;const數(shù)據(jù)成員只能在類構造函數(shù)的初始化表中進行class A A(int size); /構造函數(shù) const int SIZE;A:A(int size) : SIZE(size)A a(100); /對象a的SIZE值

21、為100A b(200); /對象b的SIZE值為200常量規(guī)則怎樣建立在整個類中都恒定的常量呢？const數(shù)據(jù)成員只在某個對象生存期內是常量，而對類而言是可變的因為類可以創(chuàng)建多個對象不同對象的const數(shù)據(jù)成員值不同 不能指望const數(shù)據(jù)成員了常量規(guī)則怎樣建立在整個類中都恒定的常量呢？應該用類中的枚舉常量來實現(xiàn) class A enum SIZE1 = 100, SIZE2 = 200; /枚舉常量 int arrayASIZE1; int arrayBSIZE2;缺點：隱含數(shù)據(jù)類型是整數(shù)，其最大值有限，且不能表示浮點數(shù) 動態(tài)數(shù)組一維動態(tài)數(shù)組 int *p = NULL;p = (int

22、*) malloc(n * sizeof (int); pi /像使用一維數(shù)組一樣使用二維動態(tài)數(shù)組int *p = NULL;p = (int *) calloc(m * n, sizeof (int);pi*n+j); /像使用一維數(shù)組一樣使用函數(shù)設計原則函數(shù)的功能要單一，不要設計多用途的函數(shù) 函數(shù)的規(guī)模要小，盡量控制在50行代碼以內1986年IBM在OS/360的研究結果：大多數(shù)有錯誤的函數(shù)都大于500行1991年對148,000行代碼的研究表明：小于143行的函數(shù)比更長的函數(shù)更容易維護函數(shù)設計原則參數(shù)的規(guī)則參數(shù)要書寫完整，不要省略參數(shù)類型和參數(shù)名沒有參數(shù)時，用void填充參數(shù)個數(shù)盡量控制

23、在5個以內參數(shù)名要恰當，順序要合理void MyStrcpy(char *str1, char *str2);void MyStrcpy(char *dstStr, char *srcStr);如果參數(shù)是指針，且僅作輸入用，則應在類型前加constvoid MyStrcpy(char *dstStr, const char *srcStr);函數(shù)設計原則返回值的規(guī)則不要省略返回值的類型，可聲明為void確保返回值與聲明的類型一致，不要依賴自動類型轉換不能返回指向棧內存的指針犯了釋放內存以后還繼續(xù)使用的錯誤函數(shù)設計原則函數(shù)內部實現(xiàn)的規(guī)則在函數(shù)的入口處，使用斷言assert檢查參數(shù)的合法性盡量少用

24、全局變量，確保函數(shù)的單入口和單出口，不得不用時，要嚴格控制對它的改寫，例如，幾個有關聯(lián)的函數(shù)需要使用全局變量時全局變量應和訪問全局變量的函數(shù)放在單獨的一個文件中，與其它文件分別編譯并且將該全局變量聲明為static（靜態(tài)全局變量） 盡量少用靜態(tài)局部變量，以避免使函數(shù)具有“記憶”功能 成對編碼寫函數(shù)體時先寫上面的大括號然后馬上就寫下面的大括號最后再插入函數(shù)體內的代碼動態(tài)申請內存時先分配一塊內存然后馬上就寫釋放這塊內存的代碼最后再在中間插入你要用這塊內存做什么的代碼所有變量要集中申請在函數(shù)的首部或塊的首部按以上方法編程不僅能保證快速正確，而且不必等代碼全部寫完就可以調試其他不要過多假設不可能發(fā)生的

25、情況總是會發(fā)生充分測試構造盡可能多的數(shù)據(jù)，變態(tài)的數(shù)據(jù)Code review讓別人看你的代碼多看別人（高手）的代碼處理錯誤機制返回錯誤信息異常處理活用斷言ASSERT()，在debug版本多用，能發(fā)現(xiàn)很多隱含的bugs內存管理5.1 內存分配方式從靜態(tài)存儲區(qū)域分配。內存在程序編譯的時候就已經(jīng)分配好，這塊內存在程序的整個運行期間都存在。例如全局變量，static變量。 在棧上創(chuàng)建。在執(zhí)行函數(shù)時，函數(shù)內局部變量的存儲單元都可以在棧上創(chuàng)建，函數(shù)執(zhí)行結束時這些存儲單元自動被釋放。棧內存分配運算內置于處理器的指令集中，效率很高，但是分配的內存容量有限。 從堆上分配，亦稱動態(tài)內存分配。程序在運行的時候用ma

26、lloc或new申請任意多少的內存，程序員自己負責在何時用free或delete釋放內存。動態(tài)內存的生存期由我們決定，使用非常靈活，但問題也最多。5.2 常見的內存錯誤內存分配未成功，卻使用了它。 內存分配雖然成功，但是尚未初始化就引用它。 內存分配成功并且已經(jīng)初始化，但操作越過了內存的邊界。 忘記了釋放內存，造成內存泄漏。 釋放了內存卻繼續(xù)使用它 5.3 習慣規(guī)則用malloc或new申請內存之后，應該立即檢查指針值是否為NULL。防止使用指針值為NULL的內存。 不要忘記為數(shù)組和動態(tài)內存賦初值。防止將未被初始化的內存作為右值使用。避免數(shù)組或指針的下標越界，特別要當心發(fā)生“多1”或者“少1”

27、操作。 動態(tài)內存的申請與釋放必須配對，防止內存泄漏。 用free或delete釋放了內存之后，立即將指針設置為NULL，防止產(chǎn)生“野指針”。 5.4 free 和 delete 的操作它們只是把指針所指的內存給釋放掉，但并沒有把指針本身干掉。 指針p被free以后其地址仍然不變（非NULL），只是該地址對應的內存是垃圾，p成了“野指針”。如果此時不把p設置為NULL，會讓人誤以為p是個合法的指針。 如果程序比較長，我們有時記不住p所指的內存是否已經(jīng)被釋放，在繼續(xù)使用p之前，通常會用語句if (p != NULL)進行防錯處理。很遺憾，此時if語句起不到防錯作用，因為即便p不是NULL指針，它也不指向合法的內存塊。 “野指針”示例5.5 動態(tài)內存會被自動釋放嗎？指針消亡了，并不表示它所指的內存會被自動釋放。 內存被釋放了，并不表示指針會消亡或者成了NULL指針。5.6 杜絕野指針“野指針”不是NULL指針，是指向“垃圾”內存的指針。人們一般不會錯用NULL指針，因為用if語句很容易判斷。但是“野指針”是很危險的，if語句對它不起作用。 “野指針”的成因主要有三種： 指針變量沒有被初始化。任何指針變量剛被創(chuàng)建時不會自動成為NULL指針，它的默認值是隨機的，它會亂