版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請(qǐng)進(jìn)行舉報(bào)或認(rèn)領(lǐng)
文檔簡(jiǎn)介
年4月19日南昌研究所軟件模塊詳細(xì)設(shè)計(jì)說明模板面向?qū)ο笪臋n僅供參考技術(shù)文件技術(shù)文件名稱:<XXX>軟件模塊詳細(xì)設(shè)計(jì)說明技術(shù)文件編號(hào):版本:擬制審核會(huì)簽標(biāo)準(zhǔn)化批準(zhǔn)中興軟件南昌研究所<模板使用說明:模板內(nèi)容供參考,能夠根據(jù)實(shí)際情況刪除或增加二級(jí)和三級(jí)標(biāo)題要求的內(nèi)容,但不能刪除一級(jí)標(biāo)題。對(duì)于模板中涉及數(shù)據(jù)的分析和統(tǒng)計(jì),建議使用表格和圖形表示,使數(shù)據(jù)更清晰直觀。在編輯完整個(gè)文檔后,點(diǎn)擊鼠標(biāo)右鍵,選擇“更新域——更新整個(gè)目錄”即可。在頁眉右上角的密級(jí)表示的此類文檔最低的密級(jí),具體產(chǎn)品能夠根據(jù)實(shí)際情況確定為更高的密級(jí),如模板要求為“機(jī)密▲”,能夠根據(jù)產(chǎn)品的重要程度能夠上升為“絕密▲”。其中包括用尖括號(hào)括起來并以藍(lán)色斜體顯示的文本,它們用于向作者提供指導(dǎo),在發(fā)布此文檔之前應(yīng)該將其刪除。修改記錄文件編號(hào)版本號(hào)擬制人/修改人擬制/修改日期更改理由主要更改內(nèi)容(寫要點(diǎn)即可)鐘倫甫-4-27建立文檔注:文件第一次擬制時(shí),“更改理由”、“主要更改內(nèi)容”欄寫“無”。>
修改記錄文件編號(hào)版本號(hào)擬制人/修改人擬制/修改日期更改理由主要更改內(nèi)容(寫要點(diǎn)即可)注:文件第一次擬制時(shí),“更改理由”、“主要更改內(nèi)容”欄寫“無”。
1 編寫目的 52 術(shù)語、定義和縮略語 52.1 術(shù)語、定義 52.2 縮略語 53 模塊描述 54 標(biāo)準(zhǔn)模塊 55 模塊設(shè)計(jì) 56 數(shù)據(jù)描述 56.1 數(shù)據(jù)結(jié)構(gòu)說明 56.2 全局變量說明 56.3 數(shù)據(jù)庫說明 57 函數(shù)定義 57.1 引用函數(shù)定義 57.2 內(nèi)部函數(shù)定義 57.2.1 內(nèi)部函數(shù)1 67.2.2 內(nèi)部函數(shù)2 67.2.3 內(nèi)部函數(shù)n 68 接口設(shè)計(jì) 68.1 用戶接口 68.2 硬件接口 68.3 軟件接口 68.3.1 規(guī)范接口 68.3.2 非規(guī)范接口 69 其它說明 610 參考資料 6編寫目的<要求:說明編寫本文件的目的在于詳細(xì)地說明××××模塊中各成分的設(shè)計(jì)考慮,以利于程序員編制程序。>術(shù)語、定義和縮略語術(shù)語、定義<要求:逐項(xiàng)列出本文中用到的難以理解或可能引起混淆的術(shù)語及其定義。>縮略語本文件應(yīng)用了以下縮略語:<要求:逐項(xiàng)列出本文中用到的縮略語及其原文和漢語含義。>模塊描述<要求:從模塊在系統(tǒng)中的位置,實(shí)現(xiàn)原理及方式、實(shí)現(xiàn)的主要功能等方面來描述該模塊的概貌。>標(biāo)準(zhǔn)模塊<要求:說明在產(chǎn)品模塊庫、事業(yè)部模塊庫中對(duì)標(biāo)準(zhǔn)模塊查詢結(jié)果、指出引用的標(biāo)準(zhǔn)模塊的內(nèi)容和應(yīng)用方式、描述本模塊中可能抽象的公用模塊及其應(yīng)用范圍>模塊設(shè)計(jì)<要求:主要用文字、圖表等形式詳細(xì)描述該模塊的狀態(tài)遷移、信號(hào)流程、程序流程、界面安排、進(jìn)程關(guān)系、異常處理、錯(cuò)誤處理等方面。詳細(xì)說明本模塊中的可測(cè)試性設(shè)計(jì),包括提供的測(cè)試接口,測(cè)試內(nèi)容和范圍等。>類定義類一描述<要求:簡(jiǎn)述此類下列相關(guān)內(nèi)容:實(shí)現(xiàn)功能在模塊中起到的作用引用此類應(yīng)注意的事項(xiàng)。>引用包列表<要求:簡(jiǎn)述此類下列相關(guān)內(nèi)容:例如:java.util.Vectorcom.ztenc.xxx。>繼承(實(shí)現(xiàn))關(guān)系<要求:繼承(實(shí)現(xiàn))的類(接口)的包的完整路徑。例如:java.util.Vector>屬性<要求:描述屬性名稱、含義、數(shù)據(jù)類型、訪問類型、修飾符以及初始值。><屬性一>含義<例如:用戶名。>數(shù)據(jù)類型<例如:java.lang.String。>訪問類型<例如:private。>修飾符<例如:無。>初始值<例如:null。>方法<方法一>功能描述訪問類型<例如:private。>修飾符<例如:static。>輸入<要求:給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義,及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>算法與處理流程<要求:說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>輸出<要求:給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。>返回<要求:說明返回值的含義。>單元定義<說明:此處定義項(xiàng)目中web頁面(asp、jsp)或其它腳本語言的詳細(xì)設(shè)計(jì)。單元是指一張頁面或一個(gè)獨(dú)立的文件中:一段完整的代碼(如jsp);一個(gè)函數(shù)(如javascript)。>單元一名稱<例如:login.jsp。>功能描述<例如:用戶登錄。>輸入<要求:給出本函數(shù)的輸入?yún)?shù)的詳細(xì)說明,包括取值范圍、含義,及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。如果是非函數(shù)(如jsp),則為無。>算法與處理流程<要求:說明本函數(shù)的關(guān)鍵實(shí)現(xiàn)方法與處理流程。明確對(duì)程序的注釋。規(guī)定對(duì)信息是否有特殊的編碼要求。>輸出<要求:給出本函數(shù)的輸出參數(shù)的詳細(xì)說明。它主要包括它的輸出值、取值范圍、含義及參數(shù)間的控制、順序、獨(dú)立或依賴等關(guān)系。如果是非函數(shù)(如jsp),則為無。>返回<要求:說明返回值的含義。如果是非函數(shù)(如jsp),則為無。>接口設(shè)計(jì)用戶接口<要求:說明由用戶提供的命令和語法結(jié)構(gòu),以及軟件的回答信息。說明誤操作的處理措施,以避免
溫馨提示
- 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請(qǐng)下載最新的WinRAR軟件解壓。
- 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請(qǐng)聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
- 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會(huì)有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
- 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
- 5. 人人文庫網(wǎng)僅提供信息存儲(chǔ)空間,僅對(duì)用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對(duì)用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對(duì)任何下載內(nèi)容負(fù)責(zé)。
- 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請(qǐng)與我們聯(lián)系,我們立即糾正。
- 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時(shí)也不承擔(dān)用戶因使用這些下載資源對(duì)自己和他人造成任何形式的傷害或損失。
最新文檔
- 2024年銀行貸款合同模板
- 2024年水電項(xiàng)目施工承攬合同規(guī)范化文本版B版
- 鄭州汽車工程職業(yè)學(xué)院《化學(xué)教學(xué)評(píng)價(jià)》2023-2024學(xué)年第一學(xué)期期末試卷
- 2024智能家居系統(tǒng)研發(fā)合作合同標(biāo)的
- 專業(yè)借款協(xié)議2024版電子文檔下載版A版
- 2024版知識(shí)產(chǎn)權(quán)許可與保護(hù)合同
- 電商公司前臺(tái)工作心得
- 2024德勝合生財(cái)富廣場(chǎng)租賃停車合同
- 2024年貨物交易中介合同2篇
- 2024幼兒園入園幼兒行為矯正與心理輔導(dǎo)協(xié)議樣本3篇
- MOOC 果樹栽培學(xué)總論-西北農(nóng)林科技大學(xué) 中國(guó)大學(xué)慕課答案
- 2024風(fēng)力發(fā)電機(jī)組 整機(jī)一階調(diào)諧質(zhì)量阻尼器
- 班車服務(wù)項(xiàng)目服務(wù)方案
- 《水電工程招標(biāo)設(shè)計(jì)報(bào)告編制規(guī)程》
- 2023年高職單獨(dú)招生考試數(shù)學(xué)試卷含答案
- 導(dǎo)管室進(jìn)修匯報(bào)課件
- T-CEPPC 13-2023 電網(wǎng)區(qū)域電碳因子和電力碳排放量核算規(guī)范
- 生產(chǎn)工廠管理手冊(cè)
- 監(jiān)控系統(tǒng)調(diào)試檢驗(yàn)批質(zhì)量驗(yàn)收記錄(新表)
- 針刺上的預(yù)防與處理
- 行業(yè)財(cái)務(wù)對(duì)標(biāo)分析
評(píng)論
0/150
提交評(píng)論