A.1 排版
程序塊要采用縮進風格編寫,縮進的TAB鍵一個。
1-2:相對獨立的程序塊之間、變量說明之后必須加空行。
1-3:較長的語句(>80字符)要分成多行書寫,長表達式要在低優先級操作符處劃分新行,操作符放在新行之首,劃分出的新行要進行適當的縮進,使排版整齊,語句可讀。
1-4:循環、判斷等語句中若有較長的表達式或語句,則要進行適應的劃分,長表達式要在低優先級操作符處劃分新行,操作符放在新行之首。
1-5:若函數或過程中的參數較長,則要進行適當的劃分。
1-6:不允許把多個短語句寫在一行中,即一行只寫一條語句。
1-7:if、while、for、default、do等語句自占一行。
1-8:對齊只使用TAB鍵,不使用空格鍵。
1-9:函數或過程的開始、結構的定義及循環、判斷等語句中的代碼都要采用縮進風格,case語句下的情況處理語句也要遵從語句縮進要求。
1-10:程序塊的分界符(如C/C++語言的大括號’{’和’}’)應各獨占一行并且位于同一列,同時與引用它們的語句左對齊。在函數體的開始、類的定義、結構的定義、枚舉的定義以及if、for、do、while0、switch、case語句中的程序都要采用如上的縮進方式。
1-11:在兩個以上的關鍵字、變量、常量進行對等操作時,它們之間的操作符之前、之后或者前后要加空格;進行非對等操作時,如果是關系密切的立即操作符(如->),后不應加空格。
1-12: 程序結構清析,簡單易懂,單個函數的程序行數不得超過100行。
A.2 注釋
2-1:一般情況下,源程序有效注釋量必須在20%以上。
2-2:說明性文件(如頭文件.h文件、.inc文件、.def文件、編譯說明文件.cfg等)頭部應進行注釋,注釋必須列出:版權說明、版本號、生成日期、作者、內容、功能、與其它文件的關系、修改日志等,頭文件的注釋中還應有函數功能簡要說明。
2-3:源文件頭部應進行注釋,列出:版權說明、版本號、生成日期、作者、模塊目的/功能、主要函數及其功能、修改日志等。
2-4:函數頭部應進行注釋,列出:函數的目的/功能、輸入參數、輸出參數、返回值、調用關系(函數、表)等。
2-5:邊寫代碼邊注釋,修改代碼同時修改相應的注釋,以保證注釋與代碼的一致性。不再有用的注釋要刪除。
2-6:注釋的內容要清楚、明了,含義準確,防止注釋二義性。
2-7:避免在注釋中使用縮寫,特別是非常用縮寫。
2-8:注釋應與其描述的代碼相近,對代碼的注釋應放在其上方或右方(對單條語句的注釋)相鄰位置,不可放在下面,如放于上方則需與其上面的代碼用空行隔開。
2-9:對于所有有物理含義的變量、常量,如果其命名不是充分自注釋的,在聲明時都必須加以注釋,說明其物理含義。變量、常量、宏的注釋應放在其上方相鄰位置或右方。
2-10:數據結構聲明(包括數組、結構、類、枚舉等),如果其命名不是充分自注釋的,必須加以注釋。對數據結構的注釋應放在其上方相鄰位置,不可放在下面;對結構中的每個域的注釋放在此域的右方。
2-11:全局變量要有較詳細的注釋,包括對其功能、取值范圍、哪些函數或過程存取它以及存取時注意事項等的說明。
2-12:注釋與所描述內容進行同樣的縮排。
2-13:將注釋與其上面的代碼用空行隔開。
2-14:對變量的定義和分支語句(條件分支、循環語句等)必須編寫注釋。
2-15:對于switch語句下的case語句,如果因為特殊情況需要處理完一個case后進入下一個case處理,必須在該case語句處理完、下一個case語句前加上明確的注釋。
A.3 標識符命名
3-1:標識符的命名要清晰、明了,有明確含義,同時使用完整的單詞或大家基本可以理解的縮寫,避免使人產生誤解。
3-2:命名中若使用特殊約定或縮寫,則要有注釋說明。
文章來源于領測軟件測試網 http://www.anti-gravitydesign.com/