1. 程式人生 > >作業20170928—1代碼規範,結對要求

作業20170928—1代碼規範,結對要求

初步 最終 空行 分行 問題 其中 填充 部分 空格

要求1 《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格,希望切實可行,容易觀察和客觀檢驗。

比如, 每個函數不超過5行,對於初學者是不切實際的; 大括號匹配縱列對齊,是切實可行的; 變量名易讀,是不易檢驗的,變量名必須是名詞短語,遵循匈牙利命名法,是易於檢驗的。 (10分)

1.大括號匹配縱列對齊。

2.為避免代碼長度過長需要斷行造成難以閱讀的問題,規定每行只寫一條語句。

3.如何處理縮進問題?當遇到有關命名空間、類、結構、函數、以及枚舉等等復雜程序結構的定義的時候,需要將它的內容縮進一層。

4.如何取變量名?規定變量名的取名原則是:變量名=屬性+類型+對象描述,其中每一對象的名稱都要求有明確含義,可以取對象名字全稱或名字的一部分。

5.使用空行分隔代碼塊。

6.分行定義變量。

7.不能使用連續的兩個或多個空格。

8.註釋要寫在函數的上方,註釋不能跟代碼寫在同一行。

9.每個代碼文件要有一個相對應的readme文檔說明。

10.編程原則是先確定代碼結構,寫出框架再逐步分模塊進行填充。

(這是我自己對於代碼風格的初步設想,最終版需要跟partner一起敲定)

要求2 記錄完成本周作業過程中,《代碼風格規範》執行情況。包括記錄每一條規則的違反和糾正、次數,規範中某項條款的增強、消弱、或廢除。在編碼過程中完全未被違反的條款,說明過於寬松,或你們已經完全"本能"反應,不應作為條款,在本要求及要求1中不得分。此種情況,應補充一條新的條款。 (20分)

作業20170928—1代碼規範,結對要求