軟工結對第一次作業
阿新 • • 發佈：2018-04-06
步驟 寫代碼 函數 報告 指針 這一 malloc 成員函數 子集
代碼審查表格
| 功能模塊名稱 | 實現C語言小子集程序的詞法分析 | |||
|---|---|---|---|---|
| 審查人 | 吳瓊 | 審查日期 | 2018.4.6 | |
| 代碼名稱 | 詞法分析程序 | 代碼作者 | 楊卓辰 | |
| 文件結構 | cpp文件 | |||
| 重要性 | 審查項 | 結論 | ||
| 頭文件和定義文件的名稱是否合理？ | 合理 | |||
| 頭文件和定義文件的目錄結構是否合理？ | 合理 | |||
| 版權和版本聲明是否完整？ | 完整 | |||
| 重要 | 頭文件是否使用了 ifndef/define/endif 預處理塊? | 沒有 | ||
| 頭文件中是否只存放“聲明”而不存放“定義” | 沒有 | |||
| 程序的版式 | ||||
| 重要性 | 審查項 | 結論 | ||
| 空行是否得體？ | 非常得體 | |||
| 代碼行內的空格是否得體？ | 得體 | |||
| 長行拆分是否得體？ | 得體 | |||
| “{” 和 “}” 是否各占一行並且對齊於同一列？ | 是 | |||
| 重要 | 一行代碼是否只做一件事？如只定義一個變量，只寫一條語句。 | 否 | ||
| 重要 | If、for、while、do等語句自占一行，不論執行語句多少都要加 “{}”。 | 是 | ||
| 重要 | 在定義變量（或參數）時，是否將修飾符 * 和 ＆ 緊靠變量名？註釋是否清晰並且必要？ | 是 | ||
| 重要 | 註釋是否有錯誤或者可能導致誤解？ | 沒有 | ||
| 重要 | 類結構的public, protected, private順序是否在所有的程序中保持一致？ | 是 | ||
| 命名規則 | ||||
| 重要性 | 審查項 | 結論 | ||
| 命名規則是否與所采用的操作系統或開發工具的風格保持一致？ | 是 | |||
| 標識符是否直觀且可以拼讀？ | 可以 | |||
| 標識符的長度應當符合“min-length && max-information”原則？ | 符合 | |||
| 程序中是否出現相同的局部變量和全部變量？ | 沒有 | |||
| 類名、函數名、變量和參數、常量的書寫格式是否遵循一定的規則？ | 沒有 | |||
| 靜態變量、全局變量、類的成員變量是否加前綴？ | 是 | |||
| 是 | ||||
| 表達式與基本語句 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重要 | 如果代碼行中的運算符比較多，是否已經用括號清楚地確定表達式的操作順序？ | 是 | ||
| 是否編寫太復雜或者多用途的復合表達式？ | 否 | |||
| 重要 | 是否將復合表達式與“真正的數學表達式”混淆？ | 否 | ||
| 重要 | 是否用隱含錯誤的方式寫if語句? 例如 | |||
| （1）將布爾變量直接與TRUE、FALSE或者1、0進行比較。 | 否 | |||
| （2）將浮點變量用“==”或“！=”與任何數字比較。 | 否 | |||
| （3）將指針變量用“==”或“！=”與NULL比較。 | 否 | |||
| 如果循環體內存在邏輯判斷，並且循環次數很大，是否已經將邏輯判斷移到循環體的外面？ | 是 | |||
| 重要 | Case語句的結尾是否忘了加break？ | 是 | ||
| 重要 | 是否忘記寫switch的default分支？ | 否 | ||
| 重要 | 使用goto 語句時是否留下隱患? 例如跳過了某些對象的構造、變量的初始化、重要的計算等。 | 否 | ||
| 常量 | ||||
| 重要性 | 審查項 | 結論 | ||
| 是否使用含義直觀的常量來表示那些將在程序中多次出現的數字或字符串？ | 是 | |||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | |||
| 重要 | 如果某一常量與其它常量密切相關，是否在定義中包含了這種關系？ | 是 | ||
| 是否誤解了類中的const數據成員？因為const數據成員只在某個對象 | ||||
| 生存期內是常量，而對於整個類而言卻是可變的。 | 否 | |||
| 函數設計 | ||||
| 重要性 | 審查項 | 結論 | ||
| 參數的書寫是否完整？不要貪圖省事只寫參數的類型而省略參數名字。 | 是 | |||
| 參數命名、順序是否合理？ | 是 | |||
| 參數的個數是否太多？ | 否 | |||
| 是否使用類型和數目不確定的參數？ | 否 | |||
| 是否省略了函數返回值的類型？ | 否 | |||
| 函數名字與返回值類型在語義上是否沖突？ | 否 | |||
| 是否將正常值和錯誤標誌混在一起返回？正常值應當用輸出參數獲得，而錯誤標誌用return語句返回。 | 否 | |||
| 在函數體的“入口處”，是否用assert對參數的有效性進行檢查？ | 是 | |||
| 使用濫用了assert？ 例如混淆非法情況與錯誤情況，後者是必然存在的並且是一定要作出處理的。 | 否 | |||
| return語句是否返回指向“棧內存”的“指針”或者“引用”？ | 是 | |||
| 是否使用const提高函數的健壯性？const可以強制保護函數的參數、返回值，甚至函數的定義體。“Use const whenever you need” | ||||
| 內存管理 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重要 | 用malloc或new申請內存之後，是否立即檢查指針值是否為NULL？（防止使用指針值為NULL的內存） | 是 | ||
| 重要 | 是否忘記為數組和動態內存賦初值？（防止將未被初始化的內存作為右值使用） | 否 | ||
| 重要 | 數組或指針的下標是否越界？ | 否 | ||
| 重要 | 動態內存的申請與釋放是否配對？（防止內存泄漏） | 是 | ||
| 重要 | 是否有效地處理了“內存耗盡”問題？ | 是 | ||
| 重要 | 是否修改“指向常量的指針”的內容？ | 是 | ||
| 重要 | 是否出現野指針？例如（1）指針變量沒有被初始化;（2）用free或delete釋放了內存之後，忘記將指針設置為NULL。 | 否 | ||
| 重要 | 是否將malloc/free 和 new/delete 混淆使用？ | 否 | ||
| 重要 | malloc語句是否正確無誤？例如字節數是否正確？類型轉換是否正 確？ | 是 | ||
| 重要 | 在創建與釋放動態對象數組時，new/delete的語句是否正確無誤？ | 是 | ||
| C++ 函數的高級特性 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重載函數是否有二義性？ | 是 | |||
| 重要 | 是否混淆了成員函數的重載、覆蓋與隱藏？ | 否 | ||
| 運算符的重載是否符合制定的編程規範？ | 是 | |||
| 是否濫用內聯函數？例如函數體內的代碼比較長，函數體內出現循環。 | 否 | |||
| 重要 | 是否用內聯函數取代了宏代碼？ | 否 | ||
| 類的構造函數、析構函數和賦值函數 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重要 | 是否違背編程規範而讓C++ 編譯器自動為類產生四個缺省的函數： | |||
| （1）缺省的無參數構造函數； | 否 | |||
| （2）缺省的拷貝構造函數； | 否 | |||
| （3）缺省的析構函數； | 否 | |||
| （4）缺省的賦值函數。 | 否 | |||
| 重要 | 構造函數中是否遺漏了某些初始化工作？ | 否 | ||
| 重要 | 是否正確地使用構造函數的初始化表？ | 是 | ||
| 重要 | 析構函數中是否遺漏了某些清除工作？ | 否 | ||
| 是否錯寫、錯用了拷貝構造函數和賦值函數？ | 否 | |||
| 重要 | 賦值函數一般分四個步驟： | |||
| （1）檢查自賦值； | ||||
| （2）釋放原有內存資源； | ||||
| （3）分配新的內存資源，並復制內容； | ||||
| （4）返回 *this。是否遺漏了重要步驟？ | ||||
| 重要 | 是否正確地編寫了派生類的構造函數、析構函數、賦值函數？ | 是 | ||
| 註意事項： | ||||
| （1）派生類不可能繼承基類的構造函數、析構函數、賦值函數。 | ||||
| （2）派生類的構造函數應在其初始化表裏調用基類的構造函數。 | ||||
| （3）基類與派生類的析構函數應該為虛（即加virtual關鍵字）。 | ||||
| （4）在編寫派生類的賦值函數時，註意不要忘記對基類的數據成員重新賦值 | ||||
| 類的高級特性 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重要 | 是否違背了繼承和組合的規則？ | 否 | ||
| （1）若在邏輯上B是A的“一種”，並且A的所有功能和屬性對B而言都有意義，則允許B繼承A的功能和屬性。 | ||||
| （2）若在邏輯上A是B的“一部分”（a part of），則不允許B從A派生，而是要用A和其它東西組合出B。 | ||||
| 其它常見問題 | ||||
| 重要性 | 審查項 | 結論 | ||
| 重要 | 數據類型問題： | |||
| （１）變量的數據類型有錯誤嗎？ | 否 | |||
| （２）存在不同數據類型的賦值嗎？ | 否 | |||
| （３）存在不同數據類型的比較嗎？ | 否 | |||
| 重要 | 變量值問題： | |||
| （１）變量的初始化或缺省值有錯誤嗎？ | 否 | |||
| （２）變量發生上溢或下溢嗎？ | 否 | |||
| （３）變量的精度夠嗎？ | 夠 | |||
| 重要 | 邏輯判斷問題： | |||
| （１）由於精度原因導致比較無效嗎？ | 否 | |||
| （２）表達式中的優先級有誤嗎？ | 否 | |||
| （３）邏輯判斷結果顛倒嗎？ | 否 | |||
| 重要 | 循環問題： | |||
| （１）循環終止條件不正確嗎？ | 正確 | |||
| （２）無法正常終止（死循環）嗎？ | 否 | |||
| （３）錯誤地修改循環變量嗎？ | 否 | |||
| （４）存在誤差累積嗎？ | 否 | |||
| 重要 | 錯誤處理問題： | |||
| （１）忘記進行錯誤處理嗎？ | 否 | |||
| （２）錯誤處理程序塊一直沒有機會被運行？ | 否 | |||
| （３）錯誤處理程序塊本身就有毛病嗎？如報告的錯誤與實際錯誤不一致，處理方式不正確等等。 | 否 | |||
| （４）錯誤處理程序塊是“馬後炮”嗎？如在被它被調用之前軟件已經出錯。 | 是 | |||
| 重要 | 文件I/O問題： | |||
| （１）對不存在的或者錯誤的文件進行操作嗎？ | 否 | |||
| （２）文件以不正確的方式打開嗎？ | 否 | |||
| （３）文件結束判斷不正確嗎？ | 正確 | |||
| （４）沒有正確地關閉文件嗎? | 否 |
此代碼的鏈接（https://coding.net/u/cyan-1031/p/zijigouzao/git/tree/master/?public=true）
總結
1.拿到楊卓辰的代碼後我首先看了一下代碼中是否存在一些格式錯誤，例如空行，或者長行拆分等，感覺她這一點做的很好，代碼的格式很規範，大括號在每一豎行上都對應，這對於我們來說也是很重的，不要讓小錯誤耽誤很長時間。其次對於一些函數的定義和聲明也都很清晰，但是建議單獨寫一個頭文件，這樣不必來回翻頁，檢查起來也比較方便。還有就是對於函數的起名她起的很清晰，這是我應該學習的地方，雖然這很不起眼，但是對於後續代碼的理解還是非常有必要的。其次他對於自己的代碼有很多註釋，這對於我這樣的讀者在方便不過了，理解起來很輕松，從她的代碼中可以看出，她的邏輯很清晰，幾乎沒有什麽太復雜的函數構造，用了一些很簡單的算法解決了問題，這是值得我去學習的。
2.此次代碼審查的確學到了很多，其實這些規則規範什麽嗎的，大一大二老師上課也總說，但是真正註意到的可能就那麽幾點而已，這次的作業讓我註意到了很多之前沒有在乎的規則，也許這個規範很不起眼，也許就成了以後寫代碼最大的隱患。我們不光要註意代碼的效率和算法的簡潔，一些必要的算法格式，就連函數的起名也必須註意到。所以真的細節決定成敗。我自己寫代碼作業就是，一個很不起眼的問題也許我就要找一個小時，真的是悔恨啊，但是經過這次的代碼審查，自己不會以前不會註意的地方，自己會多加註意並及時改正。這次作業又一次填補了自己知識的空缺，受益良多。
軟工結對第一次作業