軟件編程規(guī)范總則CHECKLIST

軟件編程規(guī)范總則CHECKLIST

檢? 查? 人：________________
檢查日期：1999年_____月_____日
審查內(nèi)容：_______________________________
審查結(jié)果：通過(guò)□??? 不通過(guò)□
說(shuō)??????? 明：__________________________________
序號(hào)?總 則 條 款?
執(zhí)行情況?
說(shuō)明
1 排版
1?1?1-1：程序塊要采用縮進(jìn)風(fēng)格編寫，縮進(jìn)的空格數(shù)為4個(gè)。?是[? ]? 否[? ]? 免[? ] ?
2?1?1-2：相對(duì)獨(dú)立的程序塊之間、變量說(shuō)明之后必須加空行。?是[? ]? 否[? ]? 免[? ] ?
3?1?1-3：較長(zhǎng)的語(yǔ)句（>80字符）要分成多行書寫，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首，劃分出的新行要進(jìn)行適當(dāng)?shù)目s進(jìn)，使排版整齊，語(yǔ)句可讀。?是[? ]? 否[? ]? 免[? ] ?
4?1?1-4：循環(huán)、判斷等語(yǔ)句中若有較長(zhǎng)的表達(dá)式或語(yǔ)句，則要進(jìn)行適應(yīng)的劃分，長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行，操作符放在新行之首。?是[? ]? 否[? ]? 免[? ] ?
5?1?1-5：若函數(shù)或過(guò)程中的參數(shù)較長(zhǎng)，則要進(jìn)行適當(dāng)?shù)膭澐帧?是[? ]? 否[? ]? 免[? ] ?
6?1?1-6：不允許把多個(gè)短語(yǔ)句寫在一行中，即一行只寫一條語(yǔ)句。?是[? ]? 否[? ]? 免[? ] ?
7?1?1-7：if、while、for、default、do等語(yǔ)句自占一行。?是[? ]? 否[? ]? 免[? ] ?
8?1?1-8：對(duì)齊只使用空格鍵，不使用TAB鍵。?是[? ]? 否[? ]? 免[? ] ?
9?1?1-9：函數(shù)或過(guò)程的開始、結(jié)構(gòu)的定義及循環(huán)、判斷等語(yǔ)句中的代碼都要采用縮進(jìn)風(fēng)格，case語(yǔ)句下的情況處理語(yǔ)句也要遵從語(yǔ)句縮進(jìn)要求。?是[? ]? 否[? ]? 免[? ] ?
10?1?1-10：程序塊的分界符（如C/C++語(yǔ)言的大括號(hào)‘{’和‘}’）應(yīng)各獨(dú)占一行并且位于同一列，同時(shí)與引用它們的語(yǔ)句左對(duì)齊。在函數(shù)體的開始、類的定義、結(jié)構(gòu)的定義、枚舉的定義以及if、for、do、while0、switch、case語(yǔ)句中的程序都要采用如上的縮進(jìn)方式。?是[? ]? 否[? ]? 免[? ] ?
11?1?1-11：在兩個(gè)以上的關(guān)鍵字、變量、常量進(jìn)行對(duì)等操作時(shí)，它們之間的操作符之前、之后或者前后要加空格；進(jìn)行非對(duì)等操作時(shí)，如果是關(guān)系密切的立即操作符（如－>），后不應(yīng)加空格。?是[? ]? 否[? ]? 免[? ] ?
2 注釋
?1?2-1：一般情況下，源程序有效注釋量必須在20％以上。?是[? ]? 否[? ]? 免[? ]?
?1?2-2：說(shuō)明性文件（如頭文件.h文件、.inc文件、.def文件、編譯說(shuō)明文件.cfg等）頭部應(yīng)進(jìn)行注釋，注釋必須列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、內(nèi)容、功能、與其它文件的關(guān)系、修改日志等，頭文件的注釋中還應(yīng)有函數(shù)功能簡(jiǎn)要說(shuō)明。?是[? ]? 否[? ]? 免[? ]?
?1?2-3：源文件頭部應(yīng)進(jìn)行注釋，列出：版權(quán)說(shuō)明、版本號(hào)、生成日期、作者、模塊目的/功能、主要函數(shù)及其功能、修改日志等。?是[? ]? 否[? ]? 免[? ]?
?1?2-4：函數(shù)頭部應(yīng)進(jìn)行注釋，列出：函數(shù)的目的/功能、輸入?yún)?shù)、輸出參數(shù)、返回值、調(diào)用關(guān)系（函數(shù)、表）等。?是[? ]? 否[? ]? 免[? ]?
?1?2-5：邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。不再有用的注釋要?jiǎng)h除。?是[? ]? 否[? ]? 免[? ]?
?1?2-6：注釋的內(nèi)容要清楚、明了，含義準(zhǔn)確，防止注釋二義性。?是[? ]? 否[? ]? 免[? ]?
?1?2-7：避免在注釋中使用縮寫，特別是非常用縮寫。?是[? ]? 否[? ]? 免[? ]?
?1?2-8：注釋應(yīng)與其描述的代碼相近，對(duì)代碼的注釋應(yīng)放在其上方或右方（對(duì)單條語(yǔ)句的注釋）相鄰位置，不可放在下面，如放于上方則需與其上面的代碼用空行隔開。?是[? ]? 否[? ]? 免[? ]?
?1?2-9：對(duì)于所有有物理含義的變量、常量，如果其命名不是充分自注釋的，在聲明時(shí)都必須加以注釋，說(shuō)明其物理含義。變量、常量、宏的注釋應(yīng)放在其上方相鄰位置或右方。?是[? ]? 否[? ]? 免[? ]?
?1?2-10：數(shù)據(jù)結(jié)構(gòu)聲明(包括數(shù)組、結(jié)構(gòu)、類、枚舉等)，如果其命名不是充分自注釋的，必須加以注釋。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋放在此域的右方。?是[? ]? 否[? ]? 免[? ]?
?1?2-11：全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。?是[? ]? 否[? ]? 免[? ]?
?1?2-12：注釋與所描述內(nèi)容進(jìn)行同樣的縮排。?是[? ]? 否[? ]? 免[? ]?
?1?2-13：將注釋與其上面的代碼用空行隔開。?是[? ]? 否[? ]? 免[? ]?
?1?2-14：對(duì)變量的定義和分支語(yǔ)句（條件分支、循環(huán)語(yǔ)句等）必須編寫注釋。?是[? ]? 否[? ]? 免[? ]?
?1?2-15：對(duì)于switch語(yǔ)句下的case語(yǔ)句，如果因?yàn)樘厥馇闆r需要處理完一個(gè)case后進(jìn)入下一個(gè)case處理，必須在該case語(yǔ)句處理完、下一個(gè)case語(yǔ)句前加上明確的注釋。?是[? ]? 否[? ]? 免[? ]?
3 標(biāo)識(shí)符命名
?1?3-1：標(biāo)識(shí)符的命名要清晰、明了，有明確含義，同時(shí)使用完整的單詞或大家基本可以理解的縮寫，避免使人產(chǎn)生誤解。?是[? ]? 否[? ]? 免[? ]?
?1?3-2：命名中若使用特殊約定或縮寫，則要有注釋說(shuō)明。?是[? ]? 否[? ]? 免[? ]?
?1?3-3：自己特有的命名風(fēng)格，要自始至終保持一致，不可來(lái)回變化。?是[? ]? 否[? ]? 免[? ]?
?1?3-4：對(duì)于變量命名，禁止取單個(gè)字符（如i、j、k...），建議除了要有具體含義外，還能表明其變量類型、數(shù)據(jù)類型等，但i、j、k作局部循環(huán)變量是允許的。?是[? ]? 否[? ]? 免[? ]?
?1?3-5：命名規(guī)范必須與所使用的系統(tǒng)風(fēng)格保持一致，并在同一項(xiàng)目中統(tǒng)一，比如采用UNIX的全小寫加下劃線的風(fēng)格或大小寫混排的方式，不要使用大小寫與下劃線混排的方式。?是[? ]? 否[? ]? 免[? ]?
4 可讀性
?1?4-1：注意運(yùn)算符的優(yōu)先級(jí)，并用括號(hào)明確表達(dá)式的操作順序，避免使用默認(rèn)優(yōu)先級(jí)。?是[? ]? 否[? ]? 免[? ]?
?1?4-2：避免使用不易理解的數(shù)字，用有意義的標(biāo)識(shí)來(lái)替代。涉及物理狀態(tài)或者含有物理意義的常量，不應(yīng)直接使用數(shù)字，必須用有意義的枚舉或宏來(lái)代替。?是[? ]? 否[? ]? 免[? ]?
5 變量
?1?5-1：去掉沒(méi)必要的公共變量。?是[? ]? 否[? ]? 免[? ]?
?1?5-2：仔細(xì)定義并明確公共變量的含義、作用、取值范圍及公共變量間的關(guān)系。??
?1?5-3：明確公共變量與操作此公共變量的函數(shù)或過(guò)程的關(guān)系，如訪問(wèn)、修改及創(chuàng)建等。??
?1?5-4：當(dāng)向公共變量傳遞數(shù)據(jù)時(shí)，要十分小心，防止賦與不合理的值或越界等現(xiàn)象發(fā)生。??
?1?5-5：防止局部變量與公共變量同名。??
?1?5-6：嚴(yán)禁使用未經(jīng)初始化的變量作為右值。??
6 函數(shù)、過(guò)程
?1?6-1：對(duì)所調(diào)用函數(shù)的錯(cuò)誤返回碼要仔細(xì)、全面地處理。?是[? ]? 否[? ]? 免[? ]?
?1?6-2：明確函數(shù)功能，精確（而不是近似）地實(shí)現(xiàn)函數(shù)設(shè)計(jì)。?是[? ]? 否[? ]? 免[? ]?
?1?6-3：編寫可重入函數(shù)時(shí)，應(yīng)注意局部變量的使用(如編寫C/C++語(yǔ)言的可重入函數(shù)時(shí)，應(yīng)使用auto即缺省態(tài)局部變量或寄存器變量)。?是[? ]? 否[? ]? 免[? ]?
?1?6-4：編寫可重入函數(shù)時(shí)，若使用全局變量，則應(yīng)通過(guò)關(guān)中斷、信號(hào)量（即P、V操作）等手段對(duì)其加以保護(hù)。?是[? ]? 否[? ]? 免[? ]?