軟件工程第一次結(jié)對(duì)作業(yè)
一、題目要求
(1). 首先在同學(xué)中找一個(gè)同伴，范圍不限，可以在1~5班中隨意組合，建議盡量不要找同組的成員，女同學(xué)盡量找男同學(xué)結(jié)對(duì)，但是不做強(qiáng)制要求；
(2). 從以往個(gè)人完成的項(xiàng)目中選擇一個(gè)作品，例如：以往的數(shù)據(jù)結(jié)構(gòu)課程設(shè)計(jì)或者其它具有比較完整功能的小系統(tǒng)，代碼至少要大于100行；
(3). 將代碼上傳至個(gè)人GitHub或Coding.net系統(tǒng)中，并將代碼地址交給對(duì)方；
(4). 對(duì)同伴的作品進(jìn)行代碼復(fù)審，并參照C/C++代碼審查表和 Java代碼審查表 這兩篇博文的內(nèi)容自行設(shè)計(jì)代碼審查表并填寫內(nèi)容；
(5). 將對(duì)伙伴審查的結(jié)果以表格的形式寫到自己的博客作業(yè)里，博客中應(yīng)該附有伙伴作業(yè)的GitHub或Coding.net的代碼地址；
(6). 對(duì)同伴的代碼寫一篇500字以上的評(píng)論，介紹同伴的優(yōu)缺點(diǎn)。
二、代碼審查表
| 功能模塊名稱 | 利用子集構(gòu)造法實(shí)現(xiàn)NFA到DFA的轉(zhuǎn)換 | ||
| 審查人 | 劉以晨 | 審查日期 | 2018.4.6 |
| 代碼名稱 | 利用子集構(gòu)造法實(shí)現(xiàn)NFA到DFA的轉(zhuǎn)換 | 代碼作者 | 胡德廣 |
| 文件結(jié)構(gòu) | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 頭文件和定義文件的名稱是否合理？ | 是 | ||
| 頭文件和定義文件的目錄結(jié)構(gòu)是否合理？ | 是 | ||
| 版權(quán)和版本聲明是否完整？ | 否 | ||
| 重要 | 頭文件是否使用了 ifndef/define/endif 預(yù)處理塊? | 否 | |
| 頭文件中是否只存放“聲明”而不存放“定義” | 是 | ||
| 程序的版式 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 空行是否得體？ | 否 | ||
| 代碼行內(nèi)的空格是否得體？ | 是 | ||
| 長(zhǎng)行拆分是否得體？ | 是 | ||
| “{” 和 “}” 是否各占一行并且對(duì)齊于同一列？ | 否 | ||
| 重要 | 一行代碼是否只做一件事？如只定義一個(gè)變量，只寫一條語(yǔ)句。 | 否 | |
| 重要 | If、for、while、do等語(yǔ)句自占一行，不論執(zhí)行語(yǔ)句多少都要加 “{}”。 | 是 | |
| 重要 | 在定義變量（或參數(shù)）時(shí)，是否將修飾符 * 和 ＆ 緊靠變量名？注釋是否清晰并且必要？ | 是 | |
| 重要 | 注釋是否有錯(cuò)誤或者可能導(dǎo)致誤解？ | 否 | |
| 重要 | 類結(jié)構(gòu)的public, protected, private順序是否在所有的程序中保持一致？ | 是 | |
| 命名規(guī)則 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 命名規(guī)則是否與所采用的操作系統(tǒng)或開(kāi)發(fā)工具的風(fēng)格保持一致？ | 是 | |
| 標(biāo)識(shí)符是否直觀且可以拼讀？ | 是 | ||
| 標(biāo)識(shí)符的長(zhǎng)度應(yīng)當(dāng)符合“min-length && max-information”原則？ | 是 | ||
| 重要 | 程序中是否出現(xiàn)相同的局部變量和全部變量？ | 否 | |
| 類名、函數(shù)名、變量和參數(shù)、常量的書(shū)寫格式是否遵循一定的規(guī)則？ | 是 | ||
| 靜態(tài)變量、全局變量、類的成員變量是否加前綴？ | 是 | ||
| 表達(dá)式與基本語(yǔ)句 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 如果代碼行中的運(yùn)算符比較多，是否已經(jīng)用括號(hào)清楚地確定表達(dá)式的操作順序？ | 是 | |
| 是否編寫太復(fù)雜或者多用途的復(fù)合表達(dá)式？ | 否 | ||
| 重要 | 是否將復(fù)合表達(dá)式與“真正的數(shù)學(xué)表達(dá)式”混淆？ | 否 | |
| 重要 | 是否用隱含錯(cuò)誤的方式寫if語(yǔ)句? 例如 | 否 | |
| （1）將布爾變量直接與TRUE、FALSE或者1、0進(jìn)行比較。 | 是 | ||
| （2）將浮點(diǎn)變量用“==”或“！=”與任何數(shù)字比較。 | 否 | ||
| （3）將指針變量用“==”或“！=”與NULL比較。 | 否 | ||
| 如果循環(huán)體內(nèi)存在邏輯判斷，并且循環(huán)次數(shù)很大，是否已經(jīng)將邏輯判 | 否 | ||
| 斷移到循環(huán)體的外面？ | 否 | ||
| 重要 | Case語(yǔ)句的結(jié)尾是否忘了加break？ | 否 | |
| 重要 | 是否忘記寫switch的default分支？ | 否 | |
| 重要 | 使用goto 語(yǔ)句時(shí)是否留下隱患? 例如跳過(guò)了某些對(duì)象的構(gòu)造、變量的初始化、重要的計(jì)算等。 | 否 | |
| 常量 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 是否使用含義直觀的常量來(lái)表示那些將在程序中多次出現(xiàn)的數(shù)字或字符串？ | 否 | ||
| 在C++ 程序中，是否用const常量取代宏常量？ | 否 | ||
| 重要 | 如果某一常量與其它常量密切相關(guān)，是否在定義中包含了這種關(guān)系？ | 否 | |
| 是否誤解了類中的const數(shù)據(jù)成員？因?yàn)閏onst數(shù)據(jù)成員只在某個(gè)對(duì)象 | 否 | ||
| 生存期內(nèi)是常量，而對(duì)于整個(gè)類而言卻是可變的。 | 否 | ||
| 函數(shù)設(shè)計(jì) | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 參數(shù)的書(shū)寫是否完整？不要貪圖省事只寫參數(shù)的類型而省略參數(shù)名字。 | 是 | ||
| 參數(shù)命名、順序是否合理？ | 是 | ||
| 參數(shù)的個(gè)數(shù)是否太多？ | 否 | ||
| 是否使用類型和數(shù)目不確定的參數(shù)？ | 否 | ||
| 是否省略了函數(shù)返回值的類型？ | 否 | ||
| 函數(shù)名字與返回值類型在語(yǔ)義上是否沖突？ | 否 | ||
| 重要 | 是否將正常值和錯(cuò)誤標(biāo)志混在一起返回？正常值應(yīng)當(dāng)用輸出參數(shù)獲得，而錯(cuò)誤標(biāo)志用return語(yǔ)句返回。 | 否 | |
| 重要 | 在函數(shù)體的“入口處”，是否用assert對(duì)參數(shù)的有效性進(jìn)行檢查？ | 否 | |
| 重要 | 使用濫用了assert？ 例如混淆非法情況與錯(cuò)誤情況，后者是必然存在的并且是一定要作出處理的。 | 否 | |
| 重要 | return語(yǔ)句是否返回指向“棧內(nèi)存”的“指針”或者“引用”？ | 否 | |
| 是否使用const提高函數(shù)的健壯性？const可以強(qiáng)制保護(hù)函數(shù)的參數(shù)、返回值，甚至函數(shù)的定義體。“Use const whenever you need” | 否 | ||
| 內(nèi)存管理 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 用malloc或new申請(qǐng)內(nèi)存之后，是否立即檢查指針值是否為NULL？（防止使用指針值為NULL的內(nèi)存） | 否 | |
| 重要 | 是否忘記為數(shù)組和動(dòng)態(tài)內(nèi)存賦初值？（防止將未被初始化的內(nèi)存作為右值使用） | 否 | |
| 重要 | 數(shù)組或指針的下標(biāo)是否越界？ | 否 | |
| 重要 | 動(dòng)態(tài)內(nèi)存的申請(qǐng)與釋放是否配對(duì)？（防止內(nèi)存泄漏） | 否 | |
| 重要 | 是否有效地處理了“內(nèi)存耗盡”問(wèn)題？ | 是 | |
| 重要 | 是否修改“指向常量的指針”的內(nèi)容？ | 否 | |
| 重要 | 是否出現(xiàn)野指針？例如（1）指針變量沒(méi)有被初始化;（2）用free或delete釋放了內(nèi)存之后，忘記將指針設(shè)置為NULL。 | 否 | |
| 重要 | 是否將malloc/free 和 new/delete 混淆使用？ | 否 | |
| 重要 | malloc語(yǔ)句是否正確無(wú)誤？例如字節(jié)數(shù)是否正確？類型轉(zhuǎn)換是否正 確？ | 是 | |
| 重要 | 在創(chuàng)建與釋放動(dòng)態(tài)對(duì)象數(shù)組時(shí)，new/delete的語(yǔ)句是否正確無(wú)誤？ | 是 | |
| C++ 函數(shù)的高級(jí)特性 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重載函數(shù)是否有二義性？ | 否 | ||
| 重要 | 是否混淆了成員函數(shù)的重載、覆蓋與隱藏？ | 否 | |
| 運(yùn)算符的重載是否符合制定的編程規(guī)范？ | 是 | ||
| 是否濫用內(nèi)聯(lián)函數(shù)？例如函數(shù)體內(nèi)的代碼比較長(zhǎng)，函數(shù)體內(nèi)出現(xiàn)循環(huán)。 | 否 | ||
| 重要 | 是否用內(nèi)聯(lián)函數(shù)取代了宏代碼？ | 否 | |
| 類的構(gòu)造函數(shù)、析構(gòu)函數(shù)和賦值函數(shù) | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 是否違背編程規(guī)范而讓C++ 編譯器自動(dòng)為類產(chǎn)生四個(gè)缺省的函數(shù)： | 否 | |
| （1）缺省的無(wú)參數(shù)構(gòu)造函數(shù)； | 否 | ||
| （2）缺省的拷貝構(gòu)造函數(shù)； | 否 | ||
| （3）缺省的析構(gòu)函數(shù)； | 否 | ||
| （4）缺省的賦值函數(shù)。 | 否 | ||
| 重要 | 構(gòu)造函數(shù)中是否遺漏了某些初始化工作？ | 否 | |
| 重要 | 是否正確地使用構(gòu)造函數(shù)的初始化表？ | 否 | |
| 重要 | 析構(gòu)函數(shù)中是否遺漏了某些清除工作？ | 否 | |
| 是否錯(cuò)寫、錯(cuò)用了拷貝構(gòu)造函數(shù)和賦值函數(shù)？ | 否 | ||
| 重要 | 賦值函數(shù)一般分四個(gè)步驟： | ||
| （1）檢查自賦值； | 否 | ||
| （2）釋放原有內(nèi)存資源； | 否 | ||
| （3）分配新的內(nèi)存資源，并復(fù)制內(nèi)容； | 否 | ||
| （4）返回 *this。是否遺漏了重要步驟？ | 無(wú) | ||
| 重要 | 是否正確地編寫了派生類的構(gòu)造函數(shù)、析構(gòu)函數(shù)、賦值函數(shù)？ | 無(wú) | |
| 注意事項(xiàng)： | |||
| （1）派生類不可能繼承基類的構(gòu)造函數(shù)、析構(gòu)函數(shù)、賦值函數(shù)。 | 無(wú) | ||
| （2）派生類的構(gòu)造函數(shù)應(yīng)在其初始化表里調(diào)用基類的構(gòu)造函數(shù)。 | 無(wú) | ||
| （3）基類與派生類的析構(gòu)函數(shù)應(yīng)該為虛（即加virtual關(guān)鍵字）。 | 無(wú) | ||
| （4）在編寫派生類的賦值函數(shù)時(shí)，注意不要忘記對(duì)基類的數(shù)據(jù)成員重新賦值 | 無(wú) | ||
| 類的高級(jí)特性 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 是否違背了繼承和組合的規(guī)則？ | 否 | |
| 無(wú) | （1）若在邏輯上B是A的“一種”，并且A的所有功能和屬性對(duì)B而言都有意義，則允許B繼承A的功能和屬性。 | 無(wú) | |
| （2）若在邏輯上A是B的“一部分”（a part of），則不允許B從A派生，而是要用A和其它東西組合出B。 | 否 | ||
| 無(wú) | |||
| 其它常見(jiàn)問(wèn)題 | |||
| 重要性 | 審查項(xiàng) | 結(jié)論 | |
| 重要 | 數(shù)據(jù)類型問(wèn)題： | 否 | |
| （１）變量的數(shù)據(jù)類型有錯(cuò)誤嗎？ | 否 | ||
| （２）存在不同數(shù)據(jù)類型的賦值嗎？ | 否 | ||
| （３）存在不同數(shù)據(jù)類型的比較嗎？ | 否 | ||
| 重要 | 變量值問(wèn)題： | 否 | |
| （１）變量的初始化或缺省值有錯(cuò)誤嗎？ | 否 | ||
| （２）變量發(fā)生上溢或下溢嗎？ | 否 | ||
| （３）變量的精度夠嗎？ | 是 | ||
| 重要 | 邏輯判斷問(wèn)題： | 是 | |
| （１）由于精度原因?qū)е卤容^無(wú)效嗎？ | 否 | ||
| （２）表達(dá)式中的優(yōu)先級(jí)有誤嗎？ | 否 | ||
| （３）邏輯判斷結(jié)果顛倒嗎？ | 否 | ||
| 重要 | 循環(huán)問(wèn)題： | 否 | |
| （１）循環(huán)終止條件不正確嗎？ | 否 | ||
| （２）無(wú)法正常終止（死循環(huán)）嗎？ | 否 | ||
| （３）錯(cuò)誤地修改循環(huán)變量嗎？ | 否 | ||
| （４）存在誤差累積嗎？ | 否 | ||
| 重要 | 錯(cuò)誤處理問(wèn)題： | ||
| （１）忘記進(jìn)行錯(cuò)誤處理嗎？ | 否 | ||
| （２）錯(cuò)誤處理程序塊一直沒(méi)有機(jī)會(huì)被運(yùn)行？ | 否 | ||
| （３）錯(cuò)誤處理程序塊本身就有毛病嗎？如報(bào)告的錯(cuò)誤與實(shí)際錯(cuò)誤不一致，處理方式不正確等等。 | 否 | ||
| （４）錯(cuò)誤處理程序塊是“馬后炮”嗎？如在被它被調(diào)用之前軟件已經(jīng)出錯(cuò)。 | 否 | ||
| 重要 | 文件I/O問(wèn)題： | ||
| （１）對(duì)不存在的或者錯(cuò)誤的文件進(jìn)行操作嗎？ | 否 | ||
| （２）文件以不正確的方式打開(kāi)嗎？ | 否 | ||
| （３）文件結(jié)束判斷不正確嗎？ | 否 | ||
| （４）沒(méi)有正確地關(guān)閉文件嗎? | 否 | ||
三、總結(jié)
1.代碼優(yōu)缺點(diǎn)
??首先呢，我們先說(shuō)一下胡德廣同學(xué)代碼存在的幾個(gè)小問(wèn)題
即“{”“}”沒(méi)有各占一行。這個(gè)問(wèn)題對(duì)于代碼本身并不會(huì)有影響，代碼不會(huì)因此出錯(cuò)，但是它有一個(gè)很重要的目的就是格式清晰，讓人看得明白，方便日后自己重新檢查代碼。
這個(gè)地方是沒(méi)有做到一行只定義一個(gè)變量，也不會(huì)造成程序運(yùn)行結(jié)果的錯(cuò)誤，但是為了格式清晰，在以后的編程過(guò)程中還是應(yīng)當(dāng)注意
整個(gè)程序有163行，不算太短，而且其中有三個(gè)重要的函數(shù)，但是卻沒(méi)有相應(yīng)的注釋，在讓人第一次看此程序的時(shí)候難免有些發(fā)懵，所以說(shuō)，以后在編程過(guò)程中添加相應(yīng)的注釋還是有必要的
以上的幾個(gè)問(wèn)題謹(jǐn)是我參考此博客之后的個(gè)人看法
2.收獲
??首先我通過(guò)此次作業(yè)充分學(xué)習(xí)到了代碼審查的概念和有關(guān)知識(shí)，代碼審查是指是指通過(guò)閱讀代碼來(lái)檢查源代碼與編碼標(biāo)準(zhǔn)的符合性以及代碼質(zhì)量的活動(dòng)，其包括編碼規(guī)范、代碼結(jié)構(gòu)等問(wèn)題，目的就是提高代碼的質(zhì)量。
??其次，從隊(duì)友胡德廣同學(xué)身上我也學(xué)到了很多，他的代碼思路清晰，結(jié)構(gòu)嚴(yán)謹(jǐn)，除了極個(gè)別地方的細(xì)節(jié)問(wèn)題之外，是極其優(yōu)秀的。他的綜合編程能力在我之上，跟他搭檔是我學(xué)習(xí)的一個(gè)好機(jī)會(huì)，我可以從他身上學(xué)到很多，向他取經(jīng)，學(xué)習(xí)他的長(zhǎng)處來(lái)彌補(bǔ)自己的不足。另外，我們兩個(gè)人合作的時(shí)候我也會(huì)打起十二分精神，共同來(lái)發(fā)現(xiàn)我們的不足，改正缺點(diǎn)，共同進(jìn)步。
??很期待接下來(lái)的結(jié)對(duì)編程作業(yè)，我相信那會(huì)是一次非常有意義、非常有趣的經(jīng)歷。
浙公網(wǎng)安備 33010602011771號(hào)