代碼規(guī)范試用稿

1、代碼規(guī)范試用稿哈爾濱工業(yè)大學(xué)計(jì)算機(jī)科學(xué)與技術(shù)學(xué)院蘇小紅1關(guān)于代碼風(fēng)格問題代碼風(fēng)格（Coding Style）是一種習(xí)慣現(xiàn)在許多大公司都對員工書寫代碼制定了規(guī)范開發(fā)大項(xiàng)目時(shí)由項(xiàng)目管理者制定代碼規(guī)范程序風(fēng)格的重要構(gòu)成因素程序版式命名規(guī)則函數(shù)設(shè)計(jì)原則其他表達(dá)式規(guī)則與零比較常量規(guī)則動(dòng)態(tài)數(shù)組內(nèi)存管理程序版式程序版式程序員的書法比書法好學(xué)得多，基本不需要特別練習(xí)但是壞習(xí)慣一旦養(yǎng)成，就像書法一樣難以改變不影響程序的功能，但影響程序的可讀性追求清晰、整潔、美觀、一目了然容易閱讀，容易測試程序版式不良的風(fēng)格int isprime(int n)int k,i;if (n = 1) return 0;k=sqrt(

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

3、不良的風(fēng)格if (year = 2000) / 良好的風(fēng)格if(year=2000) / 不良的風(fēng)格if (a=b) & (c=b&c=d) / 不良的風(fēng)格for (i=0; i10; i+) / 良好的風(fēng)格for(i=0;i10;i+) / 不良的風(fēng)格for (i = 0; i 10; i +) / 過多的空格x = a b ? a : b; / 良好的風(fēng)格x=aFunction(); / 不要寫成 b - Function();程序版式程序版式代碼行一行只寫一條語句，這樣方便測試一行只寫一個(gè)變量，這樣方便寫注釋int width; /寬度int height; /高度int depth;

4、/深度盡可能在定義變量的同時(shí)，初始化該變量int sum = 0;if、for、while、do等語句各占一行，執(zhí)行語句無論有幾條都用和將其包含在內(nèi)，這樣便于維護(hù)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();i

5、f (width height) dosomething();for (initialization; condition; update) dosomething();/ 空行other();for (initialization; condition; update) dosomething();other();程序版式程序版式修飾符*和&的位置有爭議從語義上講，靠近數(shù)據(jù)類型更直觀，但對多個(gè)變量聲明時(shí)容易引起誤解int* x, y;提倡靠近變量名int *x, y;注釋規(guī)范注釋（Comments）的重要性寫注釋給誰看？在哪些地方寫注釋？怎樣寫注釋？注釋的風(fēng)格寫注釋時(shí)的注意事項(xiàng)可靈活運(yùn)用的一

6、些規(guī)則注釋規(guī)范寫注釋給誰看？給自己看，使自己的設(shè)計(jì)思路得以連貫給繼任者看，使其能夠接替自己的工作注釋規(guī)范寫注釋的最重要的功效在于傳承要站在繼任者的角度寫簡單明了、準(zhǔn)確易懂、防止二義性讓繼任者可以輕松閱讀、復(fù)用、修改自己的代碼讓繼任者輕松辨別出哪些使自己寫的，哪些是別人寫的注釋規(guī)范不好的注釋i = i + 1; /i加1return -1; /返回-1free(p); /釋放p所指的內(nèi)存fclose(fin); /關(guān)閉文件/*/*功能描述： 本函數(shù)用于實(shí)現(xiàn)xxx功能，目的是： */ /*入口參數(shù)： 參數(shù)p，表示指向結(jié)構(gòu)體的指針 */ /*出口參數(shù)： 參數(shù)xx，表示 */ /*返回值： 返回xx值

7、，當(dāng)返回xx值時(shí)，表示 */*/注釋規(guī)范不好的注釋不但白寫，還擾亂了讀者的視線/*以二進(jìn)制只讀方式打開文件并判斷打開是否成功*/if (fin = fopen(cat.pic,rb) = NULL) puts(打開文件cat.pic失敗);/*如果打開失敗，則顯示錯(cuò)誤信息*/ return -1; /*返回-1*/*從圖像的第1行到第400行循環(huán)*/for (i=0; i400; i+) /*從圖像的第1列到第400列循環(huán)*/ for (j=0; j400; j+) /*按照公式Y(jié) = 0.299*R+0.587*G+0.114*B計(jì)算灰度值*/ y = (299 * r + 587 * g

8、+ 114 * b) / 1000; fclose(fin); /*關(guān)閉文件*/注釋規(guī)范好的注釋（尤其是算法注釋）是對設(shè)計(jì)思想的精確表述和清晰展現(xiàn)，能揭示代碼背后隱藏的重要信息/*打開輸入文件后判斷文件長度是否符合格式要求*/if (fin = fopen(cat.pic,rb) = NULL) puts(打開文件cat.pic失敗); return -1; /* * 下面是圖像轉(zhuǎn)換的算法實(shí)現(xiàn)。彩色圖像到灰度圖像的轉(zhuǎn)換主要利用RGB顏色空間到 * YUV顏色空間的變換公式來取得灰度值，公式為Y = 0.299*R+0.587*G+0.114*B */for (i=0; i400; i+) fo

9、r (j=0; j400; j+) y = (299 * r + 587 * g + 114 * b) / 1000; fclose(fin); 注釋規(guī)范在哪些地方寫注釋？在重要的文件首部文件名 + 功能說明 + 作者 + 版本 + 版權(quán)聲明 + 日期在用戶自定義函數(shù)前對函數(shù)接口進(jìn)行說明函數(shù)功能 + 入口參數(shù) +出口參數(shù) + 返回值 （包括出錯(cuò)處理）在一些重要的語句塊上方對代碼的功能、原理進(jìn)行解釋說明在一些重要的語句行右方定義一些非通用的變量函數(shù)調(diào)用較長的、多重嵌套的語句塊結(jié)束處在修改的代碼行旁邊加注釋注釋規(guī)范一塊語句的注釋風(fēng)格/* *C風(fēng)格 */C風(fēng)格 /*/*下面代碼是用來接收網(wǎng)絡(luò)數(shù)據(jù)，其

10、原理為*/* */*/ Visual C+風(fēng)格 /注釋規(guī)范一行語句的注釋風(fēng)格/*C風(fēng)格*/Visual C+風(fēng)格i = j + 1;/代碼行右方的注釋/代碼行之上的注釋i = j + 1;例子ResetSrollInfo(g_hwndThumb);/初始化滾動(dòng)條位置for循環(huán)while循環(huán) if() /if結(jié)束/while結(jié)束/for結(jié)束注釋規(guī)范可靈活運(yùn)用的一些規(guī)則注釋可長可短，但應(yīng)畫龍點(diǎn)睛，重點(diǎn)加在語義轉(zhuǎn)折處簡單的函數(shù)可以用一句話簡單說明/兩數(shù)交換void Swap(int *x, int *y)內(nèi)部使用的函數(shù)可以簡單注釋，供別人使用的函數(shù)必須嚴(yán)格注釋，特別是入口參數(shù)和出口參數(shù)Readme的

11、書寫內(nèi)容主要用來記錄日期、創(chuàng)建者、內(nèi)容等每次重大功能的添加、修改具體格式：日期TAB創(chuàng)建者TAB內(nèi)容日期:2003.1.21創(chuàng)建者:XXX內(nèi)容:實(shí)例工程日期TAB修改的文件名TAB修改的功能對修改后的功能和原理的說明日期TAB修改的文件名TAB修改的功能對修改后的功能和原理的說明類的版式“以數(shù)據(jù)為中心”的版式private類型的數(shù)據(jù)寫在前面，public類型的數(shù)據(jù)寫在后面關(guān)注類的內(nèi)部結(jié)構(gòu)“以行為為中心”的版式public類型的數(shù)據(jù)寫在前面， private類型的數(shù)據(jù)寫在后面關(guān)注的是類應(yīng)該提供什么樣的接口（或服務(wù)）提倡后者因?yàn)橛脩糇铌P(guān)心的是接口標(biāo)識符命名規(guī)則按照執(zhí)行級別分為：共性規(guī)則必須執(zhí)行簡化

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

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

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

15、不要太復(fù)雜不要多用途a = i+ + i+ + i+;printf(%d, %d, %d, i+, i+, i+);不要與數(shù)學(xué)表達(dá)式混淆if (abc) 不表示 if (ab)&(b= -EPS) & (x = EPS)if (fabs(x) = EPS)與零比較的規(guī)則指針變量與零比較不應(yīng)寫成if (p = 0) /容易誤解為整型變量if (p != 0)if (p) /容易誤解為布爾變量if (!p)應(yīng)寫成if (p = NULL) /強(qiáng)調(diào)p是指針變量if (p != NULL)常量規(guī)則盡量使用含義直觀的常量來表示多次出現(xiàn)的數(shù)字或者字符串#define PI 3.14159const flo

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

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

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