代碼規範

做業要求參見[https://edu.cnblogs.com/campus/nenu/2018fall/homework/2147]

結對同窗：王碩

 

具體條款以下：

1.全部的單行註釋用‘//’並跟在代碼上方。

2.給關鍵代碼加註釋，修改代碼時應同時修改相應的註釋，保證註釋與代碼的一致性。

3.每次測試以後要刪除無用代碼。

4.變量命名方式採用匈牙利命名法。

5.增長代碼的易讀性，對於很長的單行代碼，另起一行，規範排版。

6.定義的變量名過長時，適當縮寫，但能夠被識別出原單詞含義。

7.捕捉異常時利用try對用戶進行友好的反饋。

8.大括號應單獨佔一行，並有相應的大括號在同一列對齊。

9.全部的操做符先後加空格。

10.「變量名、函數名，都只敲一遍，之後所有是拷貝+粘貼。」——拷貝+粘貼 

執行和違反狀況：

如表：（注：W代指王碩，Z代指趙佳璐）

代碼規範約定	規範執行狀況	規則是否有效/是否進行更改
全部的單行註釋用‘//’並跟在代碼上方	W觸發3次，習慣性寫在代碼後面	規則有效，無更改
給關鍵代碼加註釋，修改代碼時應同時修改相應的註釋，保證註釋與代碼的一致性	同時觸發屢次，時常忘記及時修改註釋	規則有效，無更改
每次測試以後要刪除無用代碼	Z觸發2次，W觸發3次	規則有效，無更改
變量命名方式採用匈牙利命名法。	Z觸發7次，不熟悉命名規則	弱化規則，更改成變量含義對應的英文單詞
增長代碼的易讀性，對於很長的單行代碼，另起一行，規範排版。	W觸發2次，Z觸發1次	規則有效，無更改
定義的變量名過長時，適當縮寫，但能夠被識別出原單詞含義。	Z觸發4次	規則有效，無更改
捕捉異常時利用try對用戶進行友好的反饋。	W觸發3次	規則有效，無更改
大括號應單獨佔一行，並有相應的大括號在同一列對齊。	W觸發1次	強化規則，爲增長美觀性和代碼可讀性，大括號對應的if、while和for等也另起一行。
全部的操做符先後加空格。	同時觸發屢次	規則有效，無更改
變量名、函數名，都只敲一遍，之後所有是拷貝+粘貼。	Z觸發3次，常常打錯名字形成bug	規則有效，無更改

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

3、代碼規範總結

　　1.第一次進行結對編程。彼此的編程習慣還存在一些差別，須要磨合和統一。

　　2.相關代碼的註釋可讓彼此更能理解對方的想法。

　　3.變量和方法名的定義要有必定意義，不能隨意定義。