c語言編碼規(guī)范

1、C語言編碼規(guī)范語言編碼規(guī)范A.1排版11：程序塊要采用縮進風格編寫，縮進的TAB鍵一個。12：相對獨立的程序塊之間、變量說明之后必須加空行。13：較長的語句（80字符）要分成多行書寫，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首，劃分出的新行要進行適當?shù)目s進，使排版整齊，語句可讀。14：循環(huán)、判斷等語句中若有較長的表達式或語句，則要進行適應的劃分，長表達式要在低優(yōu)先級操作符處劃分新行，操作符放在新行之首。15：若函數(shù)或過程中

2、的參數(shù)較長，則要進行適當?shù)膭澐帧?6：不允許把多個短語句寫在一行中，即一行只寫一條語句。17：if、while、f、default、do等語句自占一行。18：對齊只使用TAB鍵，不使用空格鍵。19：函數(shù)或過程的開始、結構的定義及循環(huán)、判斷等語句中的代碼都要采用縮進風格，case語句下的情況處理語句也要遵從語句縮進要求。110：程序塊的分界符（如CC語言的大括號和）應各獨占一行并且位于同一列，同時與引用它們的語句左對齊。在函數(shù)體的開始、類

3、的定義、結構的定義、枚舉的定義以及if、f、do、while0、switch、case語句中的程序都要采用如上的縮進方式。111：在兩個以上的關鍵字、變量、常量進行對等操作時，它們之間的操作符之前、之后或者前后要加空格；進行非對等操作時，如果是關系密切的立即操作符（如－），后不應加空格。112:程序結構清析，簡單易懂，單個函數(shù)的程序行數(shù)不得超過100行。A.2注釋21：一般情況下，源程序有效注釋量必須在20％以上。22：說明性文件（如頭

4、文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等）頭部應進行注釋，注釋必須列出：版權說明、版本號、生成日期、作者、內(nèi)容、功能、與其它文件的關系、修改日志等，頭文件的注釋中還應有函數(shù)功能簡要說明。23：源文件頭部應進行注釋，列出：版權說明、版本號、生成日期、作者、模塊目的功能、主要函數(shù)及其功能、修改日志等。24：函數(shù)頭部應進行注釋，列出：函數(shù)的目的功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關系（函數(shù)、表）等。25：邊寫代碼邊注

5、釋，修改代碼同時修改相應的注釋，以保證注釋與代碼的一致性。不再有用的注釋要刪除。26：注釋的內(nèi)容要清楚、明了，含義準確，防止注釋二義性。27：避免在注釋中使用縮寫，特別是非常用縮寫。28：注釋應與其描述的代碼相近，對代碼的注釋應放在其上方或右方（對單條語句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。29：對于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時都必須加以注釋，說明其物理含義。變量、

6、常量、宏的注釋應放在其上方相鄰位置或右方。說明。72：在同一項目組或產(chǎn)品組內(nèi)，調(diào)測打印出的信息串的格式要有統(tǒng)一的形式。信息串中至少要有所在模塊名（或源文件名）及行號。73：編程的同時要為單元測試選擇恰當?shù)臏y試點，并仔細構造測試代碼、測試用例，同時給出明確的注釋說明。測試代碼部分應作為（模塊中的）一個子模塊，以方便測試代碼在模塊中的安裝與拆卸（通過調(diào)測開關）。74：在進行集成測試系統(tǒng)聯(lián)調(diào)之前，要構造好測試環(huán)境、測試項目及測試用例，同時仔細

7、分析并優(yōu)化測試用例，以提高測試效率。75：使用斷言來發(fā)現(xiàn)軟件問題，提高代碼可測性。76：用斷言來檢查程序正常運行時不應發(fā)生但在調(diào)測時有可能發(fā)生的非法情況。77：不能用斷言來檢查最終產(chǎn)品肯定會出現(xiàn)且必須處理的錯誤情況。78：對較復雜的斷言加上明確的注釋。79：用斷言確認函數(shù)的參數(shù)。710：用斷言保證沒有定義的特性或功能不被使用。711：用斷言對程序開發(fā)環(huán)境（OSCompilerHardware）的假設進行檢查。712：正式軟件產(chǎn)品中應把斷

8、言及其它調(diào)測代碼去掉（即把有關的調(diào)測開關關掉）。713：在軟件系統(tǒng)中設置與取消有關測試手段，不能對軟件實現(xiàn)的功能等產(chǎn)生影響。714：用調(diào)測開關來切換軟件的DEBUG版和正式版，而不要同時存在正式版本和DEBUG版本的不同源文件，以減少維護的難度。715：軟件的DEBUG版本和發(fā)行版本應該統(tǒng)一維護，不允許分家，并且要時刻注意保證兩個版本在實現(xiàn)功能上的一致性。A.8程序效率81：編程時要經(jīng)常注意代碼的效率。82：在保證軟件系統(tǒng)的正確性、穩(wěn)定

9、性、可讀性及可測性的前提下，提高代碼效率。83：局部效率應為全局效率服務，不能因為提高局部效率而對全局效率造成影響。84：通過對系統(tǒng)數(shù)據(jù)結構的劃分與組織的改進，以及對程序算法的優(yōu)化來提高空間效率。85：循環(huán)體內(nèi)工作量最小化。A.9質(zhì)量保證91：在軟件設計過程中構筑軟件質(zhì)量。92：代碼質(zhì)量保證優(yōu)先原則93：只引用屬于自己的存貯空間。94：防止引用已經(jīng)釋放的內(nèi)存空間。95：過程函數(shù)中分配的內(nèi)存，在過程函數(shù)退出之前要釋放。96：過程函數(shù)中申請