1、C語(yǔ)言程序代碼編寫規(guī)范(初級(jí)程序員討論版前言一個(gè)好的程序編寫規(guī)范是編寫高質(zhì)量程序的保證。清晰、規(guī)范的源程序不僅僅是方便閱讀,更重要的是能夠便于檢查錯(cuò)誤,提高調(diào)試效率,從而最終保證軟件的質(zhì)量和可維護(hù)性。說明此文擋還在完善改進(jìn)中,如有不足,歡迎指正。本文檔主要適用于剛剛開始接觸編程的初學(xué)者。對(duì)于具有一定工程項(xiàng)目開發(fā)經(jīng)驗(yàn)的程序員,建議學(xué)習(xí)C語(yǔ)言程序代碼編寫規(guī)范高級(jí)版。 目錄1 代碼書寫規(guī)范2 注釋書寫規(guī)范3 命名規(guī)范內(nèi)容1 代碼書寫規(guī)范1.1函數(shù)定義每個(gè)函數(shù)的定義和說明應(yīng)該從第1列開始書寫。函數(shù)名(包括參數(shù)表和函數(shù)體的花括號(hào)(“”和“”應(yīng)該各占一行。在函數(shù)體結(jié)尾的括號(hào)(“”后面應(yīng)該加上注釋,注釋中應(yīng)

2、該包括函數(shù)名,這樣比較方便進(jìn)行括號(hào)配對(duì)檢查,也可以清晰地看出來函數(shù)是否結(jié)束。范例1:函數(shù)的聲明void matMyFunction(int n /* matMyFunction*/1.2空格的使用使用空格分割所有演算符號(hào)和操作數(shù)。這條規(guī)則的例外是“->”,“.”, “(”和“”,這些操作符和操作數(shù)之間不空格。當(dāng)需要把一個(gè)程序行的內(nèi)容分成幾行寫時(shí),操作符號(hào)應(yīng)該放在行末,而不是下一行的開頭。1.3縮進(jìn)的設(shè)置代碼書寫應(yīng)該遵從結(jié)構(gòu)化的要求,采用縮進(jìn)的格式。最小縮進(jìn)量為4個(gè)空格,整個(gè)文件內(nèi)部應(yīng)該統(tǒng)一,不要混用Tab鍵和4個(gè)空格這兩種情況,因?yàn)椴煌木庉嬈鲗?duì)Tab鍵的處理方法不同。1.4折行的使用每

3、行的長(zhǎng)度不要超過80個(gè)字符,當(dāng)程序行太長(zhǎng)時(shí),應(yīng)該分行書寫。分行時(shí)應(yīng)該按照自然的邏輯關(guān)系進(jìn)行,例如:不要把一個(gè)簡(jiǎn)單的邏輯判斷寫在兩行上。分行后的縮進(jìn)應(yīng)該按照程序的邏輯關(guān)系進(jìn)行對(duì)齊。例如:參數(shù)表折行后,下面的行應(yīng)該在參 數(shù)表左括號(hào)的下方。范例2:折行的格式dwNewShape = matAffineTransform(coords, translation,rotation;if ( ( (new_shape.x > left_border && (new_shape.x < right_border && ( (new_shape.y > bot

4、tom_border && (new_shape.y < top_border draw(new_shape; 1.5嵌套語(yǔ)句(語(yǔ)句塊的格式對(duì)于嵌套式的語(yǔ)句-即語(yǔ)句塊(如,if、while、switch等應(yīng)該包括在花括號(hào)中。花括號(hào)的左括號(hào)應(yīng)該單獨(dú)占一行,并與關(guān)鍵字對(duì)齊。建議即使語(yǔ)句塊中只有一條語(yǔ)句,也應(yīng)該使用花括號(hào)包括,這樣可以使程序結(jié)構(gòu)更清晰,也可以避免出錯(cuò)。建議對(duì)比較長(zhǎng)的塊,在末尾的花括號(hào)后加上注釋以表明該語(yǔ)言塊結(jié)束。范例3:嵌套語(yǔ)句格式if (value < max if (value != 0 func(value; else error("The

5、 value is too big." /* if (value < max */2 注釋書寫規(guī)范注釋必須做到清晰,準(zhǔn)確地描述內(nèi)容。對(duì)于程序中復(fù)雜的部分必須有注釋加以說明。注釋量要適中,過多或過少都易導(dǎo)致閱讀困難。2.1注釋風(fēng)格語(yǔ)言中使用一組(/* */作為注釋界定符。注釋內(nèi)容盡量用英語(yǔ)方式表述。注釋的基本樣式參考范例4。注釋應(yīng)該出現(xiàn)在要說明的內(nèi)容之前,而不應(yīng)該出現(xiàn)在其后。除了說明變量的用途和語(yǔ)言塊末尾使用的注釋,盡量不使用行末的注釋方式。范例4:幾種注釋樣式/* * 強(qiáng)調(diào)注釋* * */ /* 塊注釋*/* 單行注釋*/int i; /*行末注釋*/2.2何時(shí)需要注釋如果變量的名字不能完全說明其用途,應(yīng)該使用注釋加以說明。如果為了提高性能而使某些代碼變得難懂,應(yīng)該使用注釋加以說明。對(duì)于一個(gè)比較長(zhǎng)的程序段落,應(yīng)該加注釋予以說明。如果設(shè)計(jì)文檔中有流程圖,則程序中對(duì)應(yīng)的位置應(yīng)該加注釋予以說明。如果程序中使用了某個(gè)復(fù)雜的算法,建議注明其出處。如果在調(diào)試中發(fā)現(xiàn)某段落容易出現(xiàn)錯(cuò)誤,應(yīng)該注明。 3 命名規(guī)范3.1常量、變量命名用#define定義的符號(hào)常量全部采用大寫。變量命名的基本原則:可以選擇有意義的英文(小寫字母組成變量名,使人看到該變量就能大致清楚其含義。不要使用人名、地名和漢語(yǔ)拼音。如果使用縮寫,應(yīng)該使用那些約定俗成的,而不是自己編造的。多個(gè)單詞組成