軟件編程規范總則CHECKLIST

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