C語言-程序代碼編寫規(guī)范

《C語言-程序代碼編寫規(guī)范》由會(huì)員上傳分享，免費(fèi)在線閱讀，更多相關(guān)內(nèi)容在教育資源-天天文庫。

1、C語言程序代碼編寫規(guī)范（初級(jí)程序員討論版）前言一個(gè)好的程序編寫規(guī)范是編寫高質(zhì)量程序的保證。清晰、規(guī)范的源程序不僅僅是方便閱讀，更重要的是能夠便于檢查錯(cuò)誤，提高調(diào)試效率，從而最終保證軟件的質(zhì)量和可維護(hù)性。說明·此文擋還在完善改進(jìn)中，如有不足，歡迎指正?！け疚臋n主要適用于剛剛開始接觸編程的初學(xué)者?！?duì)于具有一定工程項(xiàng)目開發(fā)經(jīng)驗(yàn)的程序員，建議學(xué)習(xí)C語言程序代碼編寫規(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)（

2、“}”）后面應(yīng)該加上注釋，注釋中應(yīng)該包括函數(shù)名，這樣比較方便進(jìn)行括號(hào)配對(duì)檢查，也可以清晰地看出來函數(shù)是否結(jié)束。范例1：函數(shù)的聲明voidmatMyFunction(intn){……}/*matMyFunction*/if、for、do、while、case、switch、default各占一行，且if、for、do、while后無論語句多少都要加花括號(hào)1.2空格的使用使用空格分割所有演算符號(hào)和操作數(shù)。這條規(guī)則的例外是“->”,““.”,“()”和“[]”，這些操作符和操作數(shù)之間不空格。當(dāng)需要把一個(gè)程序行的內(nèi)容分成幾行寫時(shí)，操作符號(hào)應(yīng)該放在行末，而不是下一行的開頭?！ざ禾?hào)后

3、，分號(hào)后（for循環(huán)）·比較、賦值、算術(shù)、邏輯等雙目運(yùn)算符前后加空格·!、++、--等單目運(yùn)算符與運(yùn)行表達(dá)式之間不加空格·->、.前后不加空格·if、for、while、switch等后面加空格，突出關(guān)鍵字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折行的使用·每行的長度不要超過80個(gè)字符，當(dāng)程序行太長時(shí)，應(yīng)該分行書寫?！し中袝r(shí)應(yīng)該按照自然的邏輯關(guān)系進(jìn)行，例如：不要把一個(gè)簡單的邏輯判斷寫在兩行上?！し中泻蟮目s進(jìn)應(yīng)該按照程序的邏

4、輯關(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.xbottom_border)&&(new_shape.y

5、括在花括號(hào)中?；ɡㄌ?hào)的左括號(hào)應(yīng)該單獨(dú)占一行，并與關(guān)鍵字對(duì)齊。建議即使語句塊中只有一條語句，也應(yīng)該使用花括號(hào)包括，這樣可以使程序結(jié)構(gòu)更清晰，也可以避免出錯(cuò)。建議對(duì)比較長的塊，在末尾的花括號(hào)后加上注釋以表明該語言塊結(jié)束。范例3：嵌套語句格式if(value2、#include"用戶自定義文件"3、#define宏定義4、全局變量定義5、函數(shù)原型聲明6、ma

6、in函數(shù)定義7、用戶自定義函數(shù)2注釋書寫規(guī)范注釋必須做到清晰，準(zhǔn)確地描述內(nèi)容。對(duì)于程序中復(fù)雜的部分必須有注釋加以說明。注釋量要適中，過多或過少都易導(dǎo)致閱讀困難。2.1注釋風(fēng)格·C語言中使用一組（/*…*/）作為注釋界定符。·注釋內(nèi)容盡量用英語方式表述?！ぷ⑨尩幕緲邮絽⒖挤独?。·注釋應(yīng)該出現(xiàn)在要說明的內(nèi)容之前，而不應(yīng)該出現(xiàn)在其后?！こ苏f明變量的用途和語言塊末尾使用的注釋，盡量不使用行末的注釋方式。范例4：幾種注釋樣式/***************************************************強(qiáng)調(diào)注釋*********************

7、*****************************//**塊注釋*//*單行注釋*/inti;/*行末注釋*/2.2何時(shí)需要注釋·如果變量的名字不能完全說明其用途，應(yīng)該使用注釋加以說明?！と绻麨榱颂岣咝阅芏鼓承┐a變得難懂，應(yīng)該使用注釋加以說明?！?duì)于一個(gè)比較長的程序段落，應(yīng)該加注釋予以說明。如果設(shè)計(jì)文檔中有流程圖，則程序中對(duì)應(yīng)的位置應(yīng)該加注釋予以說明?！と绻绦蛑惺褂昧四硞€(gè)復(fù)雜的算法，建議注明其出處?！と绻谡{(diào)試中發(fā)現(xiàn)某段落容易出現(xiàn)錯(cuò)誤，應(yīng)該注明。列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系/***