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

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

不同 都沒有 ucid word -1 代碼量 目的 tex studio

one

結對同學:黃澤宇

地址:http://www.cnblogs.com/ddzchild/p/7635239.html

two

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

《代碼規範》是在閱讀《構建之法》後我和黃澤宇同學結合實際制定的。最終確定代碼規範如下:

A.代碼量: I.代碼總行數不超過500行

II.單個函數總行數不得超過60行。

B.代碼縮進: III.《構建之法》書中有提到過Tab在不同情況下會顯示不同的長度,統一規定代碼縮進采用4個空格。

C.括號匹配: IV.“{”“}“同一級別匹配應明確就表示出代碼優先級,尤其是在多層嵌套循環函數中。

D.代碼空行: V.不同函數之間空一行。

VI.在函數內部,函數內部變量聲明與函數代碼之間空一行。

E.代碼空格: VII.函數參數列表中不同參數之間用一個空格分開。

F.變量命名: VIII.在變量聲明時應有實際意義不可憑空想象,盡量遵循“匈牙利命名法”。

G.代碼註釋: IX.闡明函數功能的註釋應放在該段函數代碼前。

X.某一行標註的註釋為防止看錯行應緊隨該行代碼右側標註。

H代碼路徑: XI.為防止代碼運行在調試加載過程中出現未知錯誤,規定代碼運行路徑在全英文路徑下,並且為防止亂碼,控制臺提示采用英

文(本次作業要求是給小學數學老師使用,此處假設小學數學老師英語水平為CET4)。

要求2《代碼風格規範》執行情況記錄。包括記錄每一條規則的違反和糾正、次數,規範中某項條款的增強、消弱、或廢除。

A.代碼量: 總代碼量是根據上網查閱資料確定的,並在最終完成代碼後沒有超出預期代碼量,最後完成的代碼總行數為349行,最長的單個函數代碼為34行。

B.代碼縮進:

C.括號匹配:

在代碼執行過程中由於代碼多層嵌套,編寫代碼時邏輯不夠清晰,導致代碼縮進出現不規範,如下圖所示:

技術分享

後期執行代碼時,根據規範檢查代碼,修改後如圖所示:

技術分享

D.代碼空行:

在編寫代碼時為了方便好記並未對代碼進行空行等嚴格的代碼規範書寫,函數之間基本都沒有空行,截取部分如下圖所示:

技術分享

後期執行代碼規範檢查代碼,修改後如圖所示:

技術分享

E.代碼空格:大部分函數聲明變量時都能夠遵循該規範,只有個別違背該規範,也可算作本能反應(所以在後面補了一條必要的代碼規範)如下圖所示:

技術分享

後期執行代碼規範檢查代碼,修改後如圖所示:

技術分享

F.變量命名:

雖有註釋但是命名不夠準確容易給人造成誤解歧義:

技術分享

後期執行代碼規範檢查代碼,修改後命名如圖所示:

技術分享

H.代碼路徑.:代碼路徑規範是在後期運行調試代碼添加的一條規範,原本控制臺采用中文提示,但是在visual studio2017中卻顯示亂碼,經過各種方法調試卻無法消除亂碼,所以添加此項規範要求。

控制臺亂碼圖如下圖所示:

技術分享

控制臺提示部分轉換成英文如下圖所示:

技術分享

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