代碼對比器設(shè)計文檔

本文格式為Word版，下載可任意編輯——代碼對比器設(shè)計文檔

哈爾濱學(xué)院軟件學(xué)院

課程設(shè)計說明書

題目：HSCodeComToolKit—哈軟代碼比較工具

院（系）軟件學(xué)院專業(yè)年級姓名指導(dǎo)教師

張晶

軟件工程09-3張鳴雷

王克朝

學(xué)號09033333職稱

2023年8月20日

哈軟代碼比較工具是一款實用的小軟件，具有文本比較功能，和文件夾比較的功能，文本比較：比較兩個文本文件的內(nèi)容。假使兩個文件完全一致，則打印“TheTwoFilesareidentical!〞；假使不完全一致，則顯示不同處所在的行號及不同點；比較結(jié)果顯示在屏幕的同時，寫入文件。文件夾比較：比較兩個文件夾內(nèi)對應(yīng)文件的異同。假使對應(yīng)的兩個文件完全一致，則顯示任何信息；假使不完全一致，則顯示文件名、不同處所在的行號及不同點，比較結(jié)果顯示在屏幕的同時，寫入文件。此文檔記錄了制作本軟件的全過程，包括需求分析，概要設(shè)計，詳細(xì)設(shè)計，和源代碼。開發(fā)此軟件，為本人增加了經(jīng)驗，得到了鍛煉。為大家提供了一款很不錯的軟件，但還有一些功能不夠完善，希望大家多提一些建議，一起將此軟進(jìn)一步完善。

關(guān)鍵字：文檔，源代碼，分析，算法

Taketo

Hasoftcodecomparisontoolisasmallutilitysoftware,withtextcomparisonfunctions,andfoldercomparisonfunction,textcomparison:acomparisonoftwothecontentsofatextfile.Ifthetwofilesareidentical,thenprintTheTwoFilesareidentical!;ifnotidentical,displaysadifferentplaceinthelinenumberanddifferentpoints;comparetheresultsdisplayedonthescreenatthesametime,writetothefile.Foldercomparison:acomparisonoftwofolderscorrespondingdocumentsimilaritiesanddifferences.Ifthetwofilesareidentical,showinganyinformation;ifnotidentical,showthefilename,linenumberanddifferentindifferentplaces,comparetheresultsdisplayedonthescreenatthesametime,writetothefile.Thisdocumentrecordstheproductionofthewholeprocessofthesoftware,includingneedsanalysis,outlinedesign,detaileddesign,andsourcecode.Developmentofthissoftware,forIhaveincreasedexperience,getexercise.Weprovideaverygoodsoftware,buttherearesomefunctionisnotperfect,Ihopeeveryoneadvice,thissofttofurtherimprove.Keywords:documentation,sourcecode,analysis,algorithm

前言

隨著通信和計算機(jī)技術(shù)的快速發(fā)展，以及經(jīng)濟(jì)全球化的推動，互聯(lián)萬表現(xiàn)出了極大的使用便利性和信息傳遞的快捷性，使得人們對信息網(wǎng)絡(luò)的依靠程度越來越大，人們在傳遞信息的同時，又有大量的信息一致，但名稱不同，浪費空間，和時間。

所以有好多人想知道文件是否一致，以及文件夾的比較是否一致，為此學(xué)校組織編寫了這款小軟件，即小又實用，此軟件開發(fā)完成，但還有一些未知的功能需要完善，為此編寫此文檔，便利用戶使用，在開發(fā)人員的開發(fā)，對軟件進(jìn)行好的管理，與應(yīng)用。

目錄

第一章需求分析

1.1引言

1.1.1編寫目的

對于HSCodeComToolKit—哈軟代碼比較工具而言，其作用是實現(xiàn)文本文件的比較，隨著互聯(lián)網(wǎng)的發(fā)展，越來越多的文本文件在網(wǎng)絡(luò)中傳播，有些文件文件名不同，內(nèi)容卻是一致的，有時自己建立的文件也可能是內(nèi)容一致，名不同，為了找出這些內(nèi)容一致的文件，將重復(fù)的刪除，以節(jié)省空間，開發(fā)這款代碼比較器，比較文本文件是否一致以及文件夾中的內(nèi)容是否一致。

此規(guī)格說明書在詳細(xì)的調(diào)查了客戶現(xiàn)有的應(yīng)用模塊和基本的操作流程后進(jìn)行編寫，對HSCodeComToolKit—哈軟代碼比較工具以及其功能進(jìn)行了詳細(xì)的規(guī)劃、設(shè)計，明確了軟件開發(fā)中應(yīng)具有的功能、性能使得系統(tǒng)的開發(fā)人員和維護(hù)人員能夠詳細(xì)明白的了解軟件是如何開發(fā)和進(jìn)行維護(hù)的，并在此基礎(chǔ)上進(jìn)一步提出概要設(shè)計說明書和完成后續(xù)設(shè)計與開發(fā)工作。

本規(guī)格說明書的預(yù)期讀者包括客戶、業(yè)務(wù)或需求分析人員、測試人員、用戶文檔編寫者、項目管理人員等。

1.1.2項目背景

軟件產(chǎn)品名稱：哈軟代碼比較工具。代碼：HSCodeComToolKit

1.2項目概述

1.2.1待開發(fā)軟件的一般描述

(1)項目目標(biāo)

①、文本比較：比較兩個文本文件的內(nèi)容。假使兩個文件完全一致，則打印“TheTwoFilesareidentical!〞；假使不完全一致，則顯示不同處所在的行號及不同點；比較結(jié)果顯示在屏幕的同時，寫入文件。

②、文件夾：比較兩個文件夾內(nèi)對應(yīng)文件的異同。假使對應(yīng)的兩個文件完全一致，則顯示任何信息；假使不完全一致，則顯示文件名、不同處所在的行號及不同點，比較結(jié)果顯示在屏幕的同時，寫入文件（2）應(yīng)交付成果

在項目開發(fā)完成后，交付內(nèi)容有編譯后的代碼比較器，應(yīng)用程序，開發(fā)文檔，設(shè)計說明書（3）項目開發(fā)環(huán)境

操作系統(tǒng)為Windows2023以上均可，使用集成開發(fā)工具vc6.0

（4）項目驗收方式與依據(jù)

項目驗收分為內(nèi)部驗收和外部驗收兩種方式。在項目開發(fā)完成后，首先進(jìn)行內(nèi)部驗收，有測試人員根據(jù)用戶需求和項目目標(biāo)進(jìn)行驗收，項目在通過內(nèi)部驗收后，交給客戶進(jìn)行驗收，驗收的主要依據(jù)為需求規(guī)格說明書

1.2.2待開發(fā)軟件的主要功能

層次方塊圖

圖1流程圖

圖

2

圖5

1.2.3用戶特征

需要比較文本文件異同或文件夾異同的人

1.2.4運行環(huán)境

硬件環(huán)境

486或更高檔PC臺式機(jī)，筆記本電腦；運行時占用內(nèi)存：1MB；安裝所需硬盤：5MB；軟件環(huán)境

可選軟件平臺：中文Windows95

Windows95、WindowsNT4.0或更高版本；Windowsxp及更高版本

1.3功能需求

1.3.1功能劃分

（1）文本文件比較（2）文件夾比較

1.3.2功能描述

（1）、文本比較：

比較兩個文本文件的內(nèi)容。假使兩個文件完全一致，則打印“TheTwoFilesareidentical!〞；假使不完全一致，則顯示不同處所在的行號及不同點；比較結(jié)果顯示在屏幕的同時，寫入文件。（2）、文件夾比較：

比較兩個文件夾內(nèi)對應(yīng)文件的異同。假使對應(yīng)的兩個文件完全一致，則顯示任何信息；假使不完全一致，則顯示文件名、不同處所在的行號及不同點，比較結(jié)果顯示在屏幕的同時，寫入文件。

1.4外部接口和需求

用戶界面

采用dos界面驅(qū)動方式，對用戶友好。

1.查詢要求：查詢界面一目了然

2.信息列表：分類明確，字體明了好認(rèn)，能快速的看到重要信息3.操作要求：能夠響應(yīng)用戶命令請求

輸入輸出格式

輸入：根據(jù)提醒輸入，輸入確鑿，主界面輸入1或2或3選擇比較

還是退出，輸入文件路徑必需帶擴(kuò)展名，文件夾不需要擴(kuò)展名。

輸出：明了輸出比較結(jié)果

1.5軟件屬性需求

①正確性:高②可靠性：高③效率：高

④易使性：

要求具有較強(qiáng)的容錯處理能力，以保證軟件的可適用性，在用戶誤操作的狀況下系統(tǒng)應(yīng)給出相應(yīng)的提醒信息，高數(shù)用戶如何進(jìn)行恢復(fù)操作，避免無法挽回的損失⑤可維護(hù)性：

為了保證系統(tǒng)的可維護(hù)性，要求具有詳細(xì)的系統(tǒng)設(shè)計文檔資料，提供全部的系統(tǒng)源程序，并盡量采用面向?qū)ο蟮某绦蛟O(shè)計方法，以提高系統(tǒng)的可靠性。同時要求系統(tǒng)的功能在一定程度上可擴(kuò)展，以滿足業(yè)務(wù)變動的需求⑥可移植性：

本系統(tǒng)開發(fā)完成后，要能運行于任何由windows2000/nt/98級以上版本操作系統(tǒng)所構(gòu)成的計算機(jī)單機(jī)環(huán)境下運行

其次章開發(fā)工具介紹及數(shù)據(jù)庫設(shè)計

2.1系統(tǒng)開發(fā)工具介紹

Dev-C++是一個Windows下的C和C++程序的集成開發(fā)環(huán)境。它使用MingW32/GCC編譯器，遵循C/C++標(biāo)準(zhǔn)。開發(fā)環(huán)境包括多頁面窗口、工程編輯器以及調(diào)試器等，在工程編輯器中集合了編輯器、編譯器、連接程序和執(zhí)行程序，提供高亮度語法顯示的，以減少編輯錯誤，還有完善的調(diào)試功能，能夠適合初學(xué)者與編程高手的不同需求，是學(xué)習(xí)C或C++的首選開發(fā)工具！多國語言版中包含簡繁體中文語言界面及技巧提醒，還有英語、俄語、法語、德語、意大利語等二十多個國家和地區(qū)語言提供選擇。

第三章概要設(shè)計

3.1引言

3.1.1編寫目的

在系統(tǒng)項目的前一階段，也就是需求分析階段中，已經(jīng)將系統(tǒng)用戶對本系統(tǒng)的需求做了詳細(xì)的闡述本階段已在系統(tǒng)的需求分析的基礎(chǔ)上，對哈軟代碼比較工具系統(tǒng)做概要設(shè)計。主要解決了實現(xiàn)該系統(tǒng)需求的程序模塊設(shè)計問題。包括如何把該系統(tǒng)劃分成若干個模塊、決定各個模塊之間的接口、模塊之間傳遞的信息，以及數(shù)據(jù)結(jié)構(gòu)、模塊結(jié)構(gòu)的設(shè)計等。在以下的概要設(shè)計報告中將對在本階段中對系統(tǒng)所做的所有概要設(shè)計進(jìn)行詳細(xì)的說明。在下一階段的詳細(xì)設(shè)計中，程序設(shè)計員可參考此概要設(shè)計報告，在概要設(shè)計對機(jī)票預(yù)定系統(tǒng)所做的模塊結(jié)構(gòu)設(shè)計的基礎(chǔ)上，對系統(tǒng)進(jìn)行詳細(xì)設(shè)計。在以后的軟件測試以及軟件維護(hù)階段也可參考此說明書，以便于了解在概要設(shè)計過程中所完成的各模塊設(shè)計結(jié)構(gòu)，或在修改時找出在本階段設(shè)計的不足或錯誤。

3.2任務(wù)概述

3.2.1目標(biāo)

項目目標(biāo)應(yīng)當(dāng)符合SMART原則，項目要完成的工作用明了的語言描述出來，校友錄系統(tǒng)項目目標(biāo)如下：（1）、文本比較：

比較兩個文本文件的內(nèi)容。假使兩個文件完全一致，則打印“TheTwoFilesareidentical!〞；假使不完全一致，則顯示不同處所在的行號及不同點；比較結(jié)果顯示在屏幕的同時，寫入文件。（2）、文件夾比較：

比較兩個文件夾內(nèi)對應(yīng)文件的異同。假使對應(yīng)的兩個文件完全一致，則顯示任何信息；假使不完全一致，則顯示文件名、不同處所在的行號及不同點，比較結(jié)果顯示在屏幕的同時，寫入文件。

3.2.2運行環(huán)境

客戶端：

操作系統(tǒng)：MicrosoftWindows98簡體中文版或以上

3.2.3需求概述

代碼比較器主要實現(xiàn)文本文件的比較，與文件夾的比較

3.3總體設(shè)計

3.3.1基本設(shè)計概念和處理流程

圖6

3.4運行設(shè)計

運行模塊組合

哈軟代碼比較工具1.文本文件比較輸入文件1的路徑輸入文件2的路徑

輸入比較結(jié)果存放的路徑2.文件夾比較輸入文件夾1的路徑輸入文件夾2的路徑

輸入比較結(jié)果文件存放的路徑3.退出

第四章詳細(xì)設(shè)計

4.1引言

4.1.1編寫目的

該詳細(xì)設(shè)計說明書的目的在于根據(jù)哈軟代碼比較工具需求說明與概要設(shè)計說明提出該系統(tǒng)的詳細(xì)設(shè)計，即系統(tǒng)的詳細(xì)架構(gòu)，主要包括程序系統(tǒng)的結(jié)構(gòu)以及各層次中每個程序的設(shè)計考慮。預(yù)期讀者為指導(dǎo)老師。

4.2軟件結(jié)構(gòu)

4.2.1需求概述

1．文本文件比較2.文件夾比較

4.2.2軟件結(jié)構(gòu)

圖7

4.3程序設(shè)計說明

4.3.1輸入項

4.3.2輸出項

比較結(jié)果輸出

4.3.3算法

（1）.文本文件比較算法

分別讀取文本1，文本2和比較結(jié)果寫入的文本的路徑，以只讀的方式開啟

問文本1和文本2，以只寫的方式開啟寫入比較結(jié)果文本，假使文件開啟失敗，輸出提醒，返回，開啟成功則同時從文件1與文件2中讀取字符，并設(shè)置行標(biāo)記i，假使讀取字符為換行，i++，假使讀取字符為EOF則比較終止，讀取來的字符進(jìn)行比較是否一致，假使不一致，輸出文件1文件2此行的內(nèi)容，假使一個文件到達(dá)行尾另一個沒有到達(dá)則，到達(dá)的中止讀入，未到達(dá)的讀到行尾，假使一個到達(dá)文件尾另一個未到達(dá)，則未到達(dá)的繼續(xù)讀取，假使一致，輸出一致，同時寫入文件，假使不同，相識不同的行號，和此行內(nèi)容，并寫入比較結(jié)果文本。

（2）.文件夾比較算法

分別讀取文件夾1，文件夾2和文件夾比較結(jié)果寫入文本的路徑，調(diào)用system命令dir，將文件夾1和文件夾2中的內(nèi)容寫入到file1和file2中，再將file1，file2的前五行去掉，然后寫入到wfile1和wfile2，從wfile1和wfile2中分別讀取時間，大小或DIR，文件名存到不同的數(shù)組中，從wfile1中讀取一條記錄，與wfile2中的所有記錄比較，假使類型一致，文件名一致，并且不是文件夾類型，調(diào)用文本比較函數(shù)1比較是否一致，將結(jié)果存入以此文件名.txt的文件中，在屏幕上顯示是否一致，是文件夾時不調(diào)用文本比較函數(shù)輸出兩個文件夾都有，假使在文件夾2中找不到，則輸出時間，大小，文件名，和只有文件夾1有，wfile1中的內(nèi)容比較終止后，用同樣的方法比較wfile2，找出只有wfile2有的。將比較結(jié)果顯示到屏幕，并寫入到比較結(jié)果文本，刪除file1file2，wfile1，wfile2。

4.3.4程序規(guī)律

圖8

4.3.4解釋設(shè)計

①在每一個模塊首部的解釋，解釋本模各變量的功能，范圍，缺省條件等所加的解釋

②必要地方對各變量的功能，范圍，缺省條件等所加的解釋③對使用的規(guī)律所加的解釋等

4.3