軟體詳細設計說明書

2022-11-19 07:09:04 字數 1485 閱讀 8947

***專案詳細設計說明書

(***模組)

文件修訂記錄

1. 簡介 5

1.1. 編寫目的 5

1.2. 適用範圍 5

軟體名稱 5

軟體功能 5

軟體應用 5

1.3. 定義及關鍵詞 5

1.4. 參考資料 5

2. 子模組1設計描述 6

2.1. 類***的設計 6

簡介 6

類圖 6

狀態設計(可選) 6

方法 6

3. 資料庫詳細設計(可選) 9

3.1. 儲存過程#/觸發器#的名稱 9

4. 錯誤處理 10

4.1. 系統錯誤 10

4.2. 介面錯誤 10

4.3. 協議錯誤 10

表目錄表1. 關鍵詞 4

表2. 類***的屬性 5

表3. 方法描述***-function 6

圖目錄圖1 類圖***-class 5

圖2 流程圖***-function 6

這部分要描述文件的目的,並指明文件的讀者。

解釋軟體產品將完成或不完成的功能

描述軟體的應用領域

表1. 關鍵詞

[1]如果在概要設計中未說明,則在此詳細描述類的職責和功能,可使用順序圖、協作圖、狀態圖來詳細描述。必要時,可描述本類與相關類之間的靜態動態關係。

圖1 類圖***-class

可以用狀態圖來描述類的狀態資訊。

可先定義相關的資料結構,再對屬性進行描述。

也可以不使用**、而使用偽**格式。

表2. 類***的屬性

j**a的函式頭注釋採用j**adoc自動生成的格式:

/*** @functions 增刪改查***

* @param string name 名字

* @return true 如果不為空則返回真,false 如果為空返回假

* @throws 無

*/c++使用以下格式:

表3. 方法描述***-function

(使用偽**、流程圖等來描述本方法的詳細實現。這部分是詳細設計的重點。可以在開發工具中編寫後再將檔案嵌入到文件中。偽**請直接寫成注釋格式,減少編碼階段的注釋工作量)

圖2 流程圖***-function

void testtask::imaptaskcmdrecv (cmdmsg *cmdmsg)

//傳送應答資料幀

//設定任務狀態為task_state_waitnext

}描述儲存過程、觸發器等的詳細實現。

使用偽**來描述詳細實現。

比如:記憶體分配失敗、任務建立失敗等錯誤是如何被處理的

描述將要產生並給外部實體用的錯誤碼

描述在協議中沒有描述的情況如何處理。(可選)

軟體詳細設計說明書

專案名稱 學生公寓資訊管理系統 日期 年月日 資訊工程學院 目錄1 引言 1 1.1編寫目的 1 1.2 專案背景 1 1.3 定義 1 1.4 參考資料 1 2 總體設計 2 2.1 需求概述 2 2.2 軟體結構 2 3 程式描述 4 3.1 下面對各模組的功能,效能,輸入,輸出進行具體描述 4...

軟體詳細設計說明書

專案名稱 學生公寓資訊管理系統 日期 年月日 資訊工程學院 目錄1 引言 1 1.1編寫目的 1 1.2 專案背景 1 1.3 定義 1 1.4 參考資料 1 2 總體設計 2 2.1 需求概述 2 2.2 軟體結構 2 3 程式描述 4 3.1 下面對各模組的功能,效能,輸入,輸出進行具體描述 4...

軟體詳細設計說明書

程式名稱 詳細設計文件 公司部門名稱 二零零九年八月 文件索引 文件審核 文件修訂 目錄1 引言 3 1.1 編寫目的 3 1.2 背景 3 1.3 定義 3 1.4 參考資料 3 2 程式系統的結構 3 3 程式設計說明 3 3.1 概述 4 3.2 功能 4 3.3 輸入項 4 3.4 輸出項 ...