實際專案:系統維護
外觀
(注意:新規範不需要這一整個部分)
假設您已經將專案交付給使用者,他們希望付錢給其他人對專案進行改進。這在行業中很常見,因為 IT 專案可能存在幾十年(IBM 的 CICS 產品於 1969 年首次釋出,至今仍然很強大)。為了讓其他人接手您的專案,您需要為他們提供完善的文件,以便他們能夠理解所有內容。為此,您需要進行系統維護。
繼承舊系統的人最想看到的是所有元件的簡要概述,這就是我們在這裡提供的。
- 不同表單如何連結在一起的結構概述
- 您將列出所有表單/模組/類並描述每個表單/模組/類的功能。
- 如果適用,請包含繼承圖
- 如果適用,請包含 E-R 圖
- 然後,您將列出每個表單/模組/類中的不同子例程並描述每個子例程的功能,並提及任何返回值或引數
您需要包含一些您最複雜演算法的示例以及您是如何構建它們的。建議您儘可能多地包含您的編碼技能的證據,但在某些情況下這將非常困難,因為您將產生如此多的程式碼,以至於不可能完全描述所有程式碼。十個複雜的程式碼片段應該足夠了。
對於每個程式碼片段,包括 3 個部分
- 用普通英語描述程式碼的功能
- 程式碼的虛擬碼概述
- 佈局合理的真實程式碼,並在必要時添加註釋
例如
普通英語
這段程式碼計算出一組巧克力棒的平均價格。為此,我首先應該使用 SQL 從“產品”表中查詢所有巧克力棒。然後,我將把所有價格加在一起,並將總額除以巧克力棒的數量以獲得平均價格。
虛擬碼
Items = (SELECT Product Price FROM products WHERE ProductType = ChocolateBar)
For Each Item
Count increases
TotalPrice = TotalPrice + Item.Price
Next Item
Output Average = TotalPrice / Count
真實程式碼
.. .. ..
對於您建立的每個模組和表單,您都應該在其背後有程式碼。本節將為標記者提供專案不同編碼元件的概述,請牢記變數資料型別及其“位”容量,例如使用字元而不是字串。
例如
模組“甜品表單”
此模組計算各種統計資訊併為資料庫中儲存的所有糖果和巧克力生成報表
| 過程/函式 | ||||
|---|---|---|---|---|
| 訪問 | 名稱 | 描述 | 引數 | 輸出/返回值 |
| 公共 | AverageChoc | 計算巧克力棒的平均價格並輸出該值 | 無 | 平均價格將列印到螢幕上 |
| 變數 | |||
|---|---|---|---|
| 訪問 | 名稱 | 型別 | 描述 |
| 私有 | NumChocBars | 整數 | 儲存當前庫存中的巧克力棒數量 |
在這裡,您為標記者提供所有程式碼。正如我們之前提到的,由於您使用了合理的名稱、縮排和註釋,因此它應該很容易理解。本節將讓標記者看到所有這些努力,並在任何不完全清楚的地方進行一些註釋。如果您已將其包含在技術解決方案中,請提供連結。
如果您使用程式建立了資料庫表,請以設計檢視顯示它們,確保人們可以看到資料型別。
如果您使用 DDL,請將其複製到這裡。