1. 程式人生 > >軟件工程第四次作業-1代碼規範

軟件工程第四次作業-1代碼規範

下劃線 多功能 是否 技術分享 說明 困難 image 變量命名 ase

結對同學:姜珊

排版規範

1.在兩個以上的關鍵字、變量、常量進行對等操作時,它們之間的操作符之前、之後或者前後要加空格;進行非對等操作時,如果是關系密切的立即操作符(如->),後不應加空格,例如:

(1) 逗號、分號只在後面加空格 printf("%d %d %d" , a, b, c);

(2)比較操作符, 賦值操作符"="、 "+=",算術操作符"+"、"%",邏輯操作符"&&"、"&",位域操作符"<<"、"^"等雙目操作符的前後加空格

(3)"!"、"~"、"++"、"--"、"&"(地址運算符)等單目操作符前後不加空格

2. 函數體的開始,類的定義,結構的定義,if、for、do、while、switch及case語句中的程序都應采用縮進方式,大括號獨占一行並且位於同一列,同時與引用它們的語句左對齊。

可理解性規範

1. 程序在必要的地方必須有註釋,註釋要準確、易懂、簡潔。

2. 註釋應與其描述的代碼相近,對代碼的註釋應放在其上方或右方(對單條語句的註釋)相鄰位置,不可放在下面,如放於上方則需與其上面的代碼用空行隔開。

3. 維護代碼時,要更新相應的註釋,刪除不再有用的註釋。 保持代碼、註釋的一致性,避免產生誤解。

4.變量命名約定

前綴是可選項,以小寫字母表示; 基本類型是必選項,以小寫字母表示;

變量名是必選項,可多個單詞(或縮寫)合在一起,每個單詞首字母大寫。

5.枚舉和枚舉成員的命名

枚舉名各單詞的字母均為大寫,單詞間用下劃線隔開。

枚舉成員的命名規則:單詞的字母全部大寫,各單詞之間用下劃線隔開;要求各成員的第一個單詞相同.

6. 函數的命名 單詞首字母為大寫,其余每個單詞首字母大寫,單詞之間不用下劃線。

7. 對指針進行充分的註釋說明,對其作用、含義、使用範圍、註意事項等說明清楚。

在對指針變量、特別是比較復雜的指針變量聲明時,應對其含義、作用及使用範圍進行註釋說明,如有必要,還應說明其使用方法、註意事項等。

可維護性

1. 在邏輯表達式中使用明確的邏輯判斷。

2. 預編譯條件不應分離完整的語句。

3. 宏所定義的多條表達式應放在大括號內。

4.使用宏時,不允許參數發生變化。

5. 函數和過程中關系較為緊密的代碼盡可能相鄰。

6.每個函數完成單一的功能,不設計多用途面面俱到的函數。 多功能集於一身的函數,很可能使函數的理解、測試、維護等變得困難。 使函數功能明確化,增加程序可讀性,亦可方便維護、測試。

程序正確性、效率

1. 嚴禁使用未經初始化的變量。

2. 防止操易混淆的字符拼寫錯誤。

3. 使用無符號類型定義位域變量。

4. 避免函數中不必要語句,防止程序中的垃圾代碼,預留代碼應以註釋的方式出現。

5.循環體內工作量最小化。

應仔細考慮循環體內的語句是否可以放在循環體之外,使循環體內工作量最小,從而提高程序的時間效率。

執行情況:

技術分享

軟件工程第四次作業-1代碼規範