《C書寫規(guī)范》PPT參考課件

1、C/C+源代碼書寫規(guī)范,1,1. 在.h/.cpp的開頭應(yīng)有一段格式統(tǒng)一的說明，內(nèi)容包括： a. 文件名 (FileName)； b. 創(chuàng)建人 (Creator)； c. 文件創(chuàng)建時(shí)間 (Date)； d. 簡短說明文件功能、用途 (Comment,2,例： / / / FileName: GetVersion.h / Creator: Liu Haifeng / Date: 2002-10-28 / Comment: Get file version information,3,2.對(duì)于主要功能函數(shù)應(yīng)有注釋說明。內(nèi)容包括：功能、入口/出口參數(shù)，必要時(shí)還可有備注或補(bǔ)充說明，對(duì)于函數(shù)中的主要功能

2、代碼，也應(yīng)有注釋說明。注釋以英文為主,4,例： /Remarks: / Check file whether exist / /Parameters: / LPCTSTR lpszPathName : Input full path name / /Return values: / int : Non-zero means success / Zero means failure,5,3. 每列代碼的長度推薦為80列，最長不得超過120列；折行以對(duì)齊為準(zhǔn)。 例：HANDLE KSOpenFile(const char cszFileName, int nMode); 或者： BOOL KSRe

3、adFile( HANDLE hFile, void *pvBuffer, int nReadSize, int *pnReadSize,6,4. 循環(huán)、分支代碼，判斷條件與執(zhí)行代碼不得在同一行上。 例：正確： if (n = -2) n = 1; else n = 2; 不得寫做： if (n = -2) n = 1; else n = 2,7,5. 指針的定義，* 號(hào)既可以緊接類型，也可以在變量名之前。 例：可寫做： int* pnsize; 也可寫做：int *pnsize; 但不得寫做：int * pnsize,8,6. 在類的成員函數(shù)內(nèi)調(diào)用非成員函數(shù)時(shí)，在非成員函數(shù)名前必須加上:。

4、例：:Sleep(2000,9,7. 函數(shù)入口參數(shù)有缺省值時(shí)，應(yīng)注釋說明。 例: BOOL KSSaveToFile( const char cszFileName, BOOL bCanReplace /* = TRUE */ ); 或者： BOOL KSSaveToFile( const char cszFileName, BOOL bCanReplace / = TRUE,10,8. else if 必須寫在一行,11,9. 與、有關(guān)的各項(xiàng)規(guī)定： 9.1、應(yīng)獨(dú)占一行。在該行內(nèi)可有注釋。 例：正確： for (i = 0; i cbLine; i+) / . printf(Line %d:,

5、 i); printf(%sn, pFileLines); 不得寫做： for (i = 0; i cb; i+) printf(Line %d:, i); printf(%sn, pFileLines);,12,9.2必須另起一行，之后的代碼必須縮進(jìn)一個(gè)Tab。與必須在同一列上。 例：正確： if (i 0) m = 1; n+;,13,不得寫做： if (i 0) m = 1; n+; 例外： if (i = 0) ASSERT(FALSE); return;,14,9.3 在循環(huán)、分支之后若只有一行代碼，雖然可省略、，但不推薦這么做。若省略后可能引起歧義，則必須加上、。 例：正確： if

6、 (n = -2) n = 1; Else n = 2,15,或者： if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3;,16,不得寫做： if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3,17,不推薦： if (i 1) n = 3;,18,10. 與空格有關(guān)的各項(xiàng)規(guī)定。 10.1 在所有兩目、三目運(yùn)算符的兩邊都必須有空格。在單目運(yùn)算符兩端不必空格。但在-、:、.、等運(yùn)算符前后，及 for (int i = nMinLine; i = nMaxLine; i+)

7、 不得寫做： int n=0, nTemp; for ( int i=nMinLine; i=nMaxLine; i+,20,10.2 for、while、if 等關(guān)鍵詞之后應(yīng)有1個(gè)空格，再接(，之后無空格；在結(jié)尾的)前不得有空格。 例：正確： if (-2 = n) 不得寫做： if(-2 = n) 或 if ( -2 = n ) 等等,21,10.3 調(diào)用函數(shù)、宏時(shí)，(、)前后不得有空格。 例：正確： printf(%dn, nIndex); 不得寫做： printf (%dn, nIndex); printf( %dn, nIndex ); 等等,22,10.4 類型強(qiáng)制轉(zhuǎn)換時(shí)，()前后

8、不得有空格 例：可寫做： (KSFile*)pFile; 也可寫做： (KSFile *)pFile 不得寫做： ( KSFile* )pFile ( KSFile * ) pFile,23,11. 與縮進(jìn)有關(guān)的各項(xiàng)規(guī)定 11.1 縮進(jìn)以 Tab 為單位。 1 個(gè) Tab 為 4 個(gè)空格 11.2 下列情況，代碼縮進(jìn)一個(gè) Tab: 1. 函數(shù)體相對(duì)函數(shù)名及、。 例： int Power(int x) return (x * x);,24,2. if、else、for、while、do 等之后的代碼。 3. 一行之內(nèi)寫不下，折行之后的代碼，應(yīng)在合理的位置進(jìn)行折行。若有 + - * / 等運(yùn)算符，

9、則運(yùn)算符應(yīng)在上一行末尾，而不應(yīng)在下一行的行首,25,11.3 下列情況，不必縮進(jìn)：switch 之后的 case、default。 例： switch (nID) case ID_PLAY: . break; case ID_STOP: . break; default: . break;,26,12.對(duì)于涉及到系統(tǒng)的功能調(diào)用，要求使用系統(tǒng)提供的宏，不得直接使用具體的數(shù)值。 例： char szSystemPathMAX_PATH = 0; 正確 char szSystemPath260 = 0; 錯(cuò)誤,27,13.關(guān)于函數(shù)編寫的規(guī)定 13.1 除了非常簡單的函數(shù)或者沒有必要，函數(shù)需要有返回值

10、，并且推薦 返回值的類型為int，成功時(shí)為 true，失敗時(shí)為false。不推薦直接使用1和0來表示。 13.2 在函數(shù)內(nèi)部變量定義全部放在函數(shù)的開始處，不能在代碼中間出現(xiàn) 變量定義。變量定義需要初始化值，一般是0、false、NULL等,28,13.3 程序員自行編寫的函數(shù)不推薦使用DWORD等指明字節(jié)長度的變量 類型，推薦使用unsigned long等變量類型。對(duì)于ULONG等vc系統(tǒng)定義的變量類型，推薦使用unsigned long 來代替。如果調(diào)用系統(tǒng)API，在MSDN中已經(jīng)指明了是DWORD等類型，則可以使用。 13.4 推薦使用int nResult作為函數(shù)自身的返回值變量，int nRetCode、BOOL bRetCode作為調(diào)用其他函數(shù)的返回值變量,29,13