軟件工程第四次作業——代碼規範
作業要求:https://edu.cnblogs.com/campus/nenu/SWE2017FALL/homework/993
代碼規範文檔:
結對夥伴:田繼平
一、代碼規範原因:
代碼是程序員的面子,《構建之法》第59頁寫到“軟件都是在相互合作中完成的,合作的最小單位是兩個人,兩個工程師在一起,做的最多的事情就是‘看代碼’。每個人都能看別人你的代碼,並發表意見。”,第60頁寫到“計算機只關心編譯生成的機器碼,你的程序采用哪種縮進風格,變量名有無統一的規範等,與機器碼的執行無關”,所以,代碼格式最終還是人在看。由此可見,編寫出整潔優雅的代碼顯得尤為重要。
二、代碼規範:
要求1:《代碼規範》包括10項條款。制定條款的目的是在程序設計的過程中(觸犯和)約束代碼風格,希望切實可行,容易觀察和客觀檢驗。
(一)、 代碼風格規範
1、 縮進
4個空格。
在Visual Studio 和其他的一些編輯工具中都可以定義Tab鍵擴展成幾個空格鍵。不用Tab鍵的原因:Tab鍵在不同的情況下會顯示不同的長度,嚴重幹擾閱 讀體驗。
2、 空格
A、函數名之後不留空格,緊跟左括號“(”。
B、一元操作符(如“ !”、“ ++”、“ --”)等前後不加空格。
C、使用if{} else,不要一直用if去判斷
3、 斷行
不把多條語句放在一行上。eg: a = 1;
b = 2;
4、 括號
A 、對齊。
在復雜的條件表達式中,用括號清楚的表示邏輯優先級。
B、 大括號匹配縱行對齊。
5、 大小寫
變量、參數:全小寫。eg: int name;
6、 註釋
本次作業代碼註釋采用“ //…”。
註釋位置:與被描述的代碼相鄰,上方或右方,不放下方。
邊寫代碼或改代碼邊註釋,可保證註釋與代碼的一致。不留多余無用的註釋。
(二)、代碼設計規範
1、if 後面必須加else。
2、一個函數實現一個功能。
要求2 :記錄完成本周作業過程中,《代碼風格規範》執行情況。
1、縮進
糾正次數 14次
2、函數名之後不留空格,緊跟左括號”(“
糾正次數 4次
3、像 if、 for、等關鍵字之後有空格,再跟左括號“(“
糾正次數 2次
4 、使用if{} else,不要一直用if去判斷
糾正次數 2次
5 、不把多條語句放在一行上
糾正次數 2次
6、 在復雜的條件表達式中,用括號清楚的表示邏輯優先級。
糾正次數 3次
7、大括號匹配縱行對齊
糾正次數 5次
8、變量、參數:全小寫。eg: int name
糾正次數 6次
9、 註釋位置:與被描述的代碼相鄰,上方或右方,不放下方。
糾正次數 4次
10、邊寫代碼或改代碼邊註釋,可保證註釋與代碼的一致。不留多余無用的註釋。
糾正次數 6次
軟件工程第四次作業——代碼規範