2020軟體工程第三次作業

部落格資訊

瀋陽航空航天大學計算機學院2020軟體工程作業

作業要求

課程目標

熟悉乙個「高質量」軟體的開發過程

作業目標

熟悉**規範及結對互審

一、專案介紹：

設計一英文詞頻統計程式，根據功能需要選擇合適的儲存結構，具體功能如下：

1、統計英文文章中每乙個單詞出現的頻率，並且輸出單詞出現的首位置（記錄行列）。

2、根據使用者輸入的兩個闕值a和b，闕值由鍵盤輸入，將詞頻大於a的和詞頻小於b的所有單詞輸出。

二、**：

小夥伴**：

小夥伴部落格：

三、**審查表：

功能模組名稱

英文詞頻統計程式

審查人石姍

審查日期

2023年4月16日

**名稱

word--frequency

**作者

郭書含檔案結構

重要性審查項

結論標頭檔案和定義檔案的名稱是否合理？

是標頭檔案和定義檔案的目錄結構是否合理？

是版權和版本宣告是否完整？無重要

標頭檔案是否使用了 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常量取代巨集常量？是重要

如果某一常量與其它常量密切相關，是否在定義中包含了這種關係？

否函式設計

重要性審查項

結論引數的書寫是否完整？不要貪圖省事只寫引數的型別而省略引數名字。

是引數命名、順序是否合理？

是引數的個數是否太多？

否是否使用型別和數目不確定的引數？

否是否省略了函式返回值的型別？

否函式名字與返回值型別在語義上是否衝突？否重要

是否將正常值和錯誤標誌混在一起返回？正常值應當用輸出引數獲得，而錯誤標誌用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。是否遺漏了重要步驟？

無其他常見問題

重要性審查項

結論重要

資料型別問題：

（１）變數的資料型別有錯誤嗎？

無（２）存在不同資料型別的賦值嗎？

否（３）存在不同資料型別的比較嗎？否重要

變數值問題：

（１）變數的初始化或預設值有錯誤嗎？

無（２）變數發生上溢或下溢嗎？

否（３）變數的精度夠嗎？是重要

邏輯判斷問題：

（１）由於精度原因導致比較無效嗎？

否（２）表示式中的優先順序有誤嗎？

無誤（３）邏輯判斷結果顛倒嗎？否重要

迴圈問題：

（１）迴圈終止條件不正確嗎？

正確（２）無法正常終止（死迴圈）嗎？

無（３）錯誤地修改迴圈變數嗎？

否（４）存在誤差累積嗎？

不存在重要

錯誤處理問題：

（１）忘記進行錯誤處理嗎？

否（２）錯誤處理程式塊一直沒有機會被執行？

無（３）錯誤處理程式塊本身就有毛病嗎？如報告的錯誤與實際錯誤不一致，處理方式不正確等等。

無（４）錯誤處理程式塊是「馬後炮」嗎？如在被它被呼叫之前軟體已經出錯。無重要

檔案i/o問題：

（１）對不存在的或者錯誤的檔案進行操作嗎？

否（２）檔案以不正確的方式開啟嗎？

否（３）檔案結束判斷不正確嗎？

正確（４）沒有正確地關閉檔案嗎?

否四、**評價：

本次的結對作業中我不僅了解到**規範的重要性，還學習到了很多。

這次的結對作業我的結對小夥伴是郭書含同學，他的課設題目是英文詞頻統計程式，在這次讀他的**過程中，我發現了別人**中的優秀之處，發現自己平時寫**沒有注意和嘗試過的東西有很多。以下是對本次小夥伴**的評價：

優點：1、函式命名規範，能夠讓人輕易讀懂。

2、**的布局很有條理，包括空行和空格也很合理，讓人看上去很舒服。

3、**注釋得當，該有的解釋都有，增強了**的可讀性。

4、結構體的應用比較熟練，使用的規範，恰當。

5、讀取檔案的過程，設定的也很合理，有對不存在檔案操作過程。

6、整個程式很清晰明了，結構功能嚴謹。

缺點：1、全域性常量的定義多餘，後面並沒有用到。

2、申請動態記憶體後沒有及時釋放。

3、變數的命名不太規範。

以前從來沒有注意過**的規範問題，寫**時也是想怎麼寫就怎麼寫，注釋不寫，中括號不對齊，但通過本次的結對學習，我學習到了別人的優點，也看到了自己的很多不足之處，我會在今後的**編寫過程中，規範程式設計，多借鑑，多學習。

2020軟體工程第三次作業

2020軟體工程第三次作業

軟體工程第三次作業

軟體工程第三次作業

相關推薦