軟件工程第四次做業—代碼規範—[結對劉成志]

1、 本次代碼規範目的

　　(一)制定10條切實可行的代碼規範

　　(二)根據制定方案實際執行狀況

2、代碼規範的要求

代碼規範做業地址：https://edu.cnblogs.com/campus/nenu/SWE2017FALL/homework/993

3、代碼規範的實施過程

（一）結對編程所制定的十條代碼規範：

　　1.括號位置匹配，每個‘{‘必須在代碼結束後的相應位置有與其匹配的‘}’。

　　2.函數中的方法名所有用小寫英文顯示。

　　3.申請的變量都用小寫顯示。

　　4.必要的單行註釋用‘//’跟在代碼下方或後方。

　　5.在函數方法前須要必要的說明用 「/*」和「*/」進行多行註釋。

　　6.方法外的全局變量定義爲static類型。

　　7.對於前期進行測試的無效代碼進行刪除。

　　8.方法與方法之間基本會有一到兩個Enter鍵。

　　9.申請的集合設置類型爲Object類型，能夠放字符串和數值類型。

　　10.基本實現一行一操做代碼，加強代碼閱讀可讀性。

（二）規範執行狀況：（**注：chen爲陳建宇/liu爲劉成志）

代碼規範約定	規範執行狀況	規則是否有效/是否進行更改
括號位置匹配，每個‘{‘必須在代碼結束後的相應位置有與其匹配的‘}’。	if/while條件不自動生成，Chen在if條件處出過兩次括號不對齊/liu在代碼刪除的時候直接將}前面的縮進刪到代碼後	規範有效/不進行更改
函數中的方法名所有用小寫英文顯示。	chen觸發五次（定義方法名後一個單詞首字母用大寫）/劉觸發兩次次（定義方法名每一個單詞首字母大寫）	規範有效/不進行更改
函數中的變量名所有用小寫英文顯示。	chen觸發一次，在定義棧時候變量用大寫	規範有效/不進行更改
必要的單行註釋用‘//’跟在代碼下方或後方。	兩人前期同時觸發屢次（後期代碼加註釋）	規範有效/不進行更改
函數方法前須要必要的說明用 「/*」和「*/」進行多行註釋。	兩人前期同時觸發屢次（後期代碼加註釋）	規範有效/不進行更改
方法外的全局變量定義爲static類型。	chen觸發兩次（調試時候進行更改）	規範有效/不進行更改
對於前期進行測試的無效代碼進行刪除。	chen觸發八次/liu觸發十二次（前期測試代碼時候用//或者/**/來註釋了不用的代碼）	規範有效/不進行更改
方法與方法之間基本會有一到兩個Enter鍵。	liu觸發三次	規範有效/不進行更改
申請的集合設置類型爲Object類型，能夠放字符串和數值類型。	chen觸發一次（調試程序過程當中發現錯誤）	規範有效/不進行更改
基本實現一行一操做代碼，加強代碼閱讀可讀性。	liu觸發三次（多個變量在同行進行定義）	規範有效/不進行更改

3、代碼規範總結

　　1.結對編程中由於是兩我的一塊兒編程，根據不一樣人的不一樣習慣，必要的代碼規範仍是有必要進行統一的定義。

　　2.相關代碼的註釋是必要的，可能單我的所寫的方法其餘人不必定能很快能讀懂。

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

　　4.必要的換行，增長代碼直觀閱讀性。

　　5.後期調試註明誰在哪塊進行調試，修改某塊代碼。