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