【正文】 件的接口的變化； d．精度和有效時(shí)限的變化； e．計(jì)劃的變化或改進(jìn)。 3． 3 輸人輸出要求 解釋各輸入輸出數(shù)據(jù)類型，并逐項(xiàng)說明其媒體、格式、數(shù)值范圍、精度等。 3． 4 數(shù)據(jù)管理能力要求 說明需要管理的文卷和記錄的個(gè)數(shù)、表和文卷的大小規(guī)模，要按可預(yù)見的增長(zhǎng)對(duì)數(shù)據(jù)及其分量的存儲(chǔ)要求作出估算。 3． 6 其他專門要求 如用戶單位對(duì)安全保密的要求，對(duì)使用方便的要求，對(duì)可維護(hù)性、可補(bǔ)充性、易讀性、可靠性、運(yùn)行環(huán)境可轉(zhuǎn)換性的特殊要求等。說明其中的新型設(shè)備及其專門功能，包括： a．處理器型號(hào)及內(nèi)存容量； b．外存容量、聯(lián)機(jī)或脫機(jī)、媒體及其存儲(chǔ)格式，設(shè)備的型號(hào)及數(shù)量； c．輸入及輸出設(shè)備的型號(hào)和數(shù)量，聯(lián)機(jī)或脫機(jī)； d．?dāng)?shù)據(jù)通信設(shè)備的型號(hào)和數(shù)量； e．功能鍵及其他專用硬件 4． 2 支持軟件 列出支持軟件 ,包括要用到的操作系統(tǒng)、編譯（或匯編）程序、測(cè)試支持軟件等。 4． 4 控制 說明控制該軟件的運(yùn)行的方法 和控制信號(hào)，并說明這些控制信號(hào)的來源。 1． 2 背景 說明： a．待開發(fā)軟件系統(tǒng)的名稱； b．本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶和運(yùn)行該程序系統(tǒng)的計(jì)算中心。 1． 4 參考資料 列出有關(guān)的參考資料，如： a．本項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文； b．屬于本 項(xiàng)目的其他已發(fā)表的文件； c．本文件中各處引用到的文件資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。 2 程序系統(tǒng)的結(jié)構(gòu) 用一系列圖表列出本程序系統(tǒng)內(nèi)的每個(gè)程序（包括每個(gè)模塊和子程序）的名稱、標(biāo)識(shí)符和它們之間 的層次結(jié)構(gòu)關(guān)系。以下給出的提綱是針對(duì)一般情況的。 3． 1 程序描述 給出對(duì)該程序的簡(jiǎn)要描述，主要說明安排設(shè)計(jì)本程序的目的意義，并且，還要說明本程序的特點(diǎn)（如 是常駐內(nèi)存還是非常駐？是否子程序？是可重人的還是不可重人的？有無覆蓋要求？是順序處理還是并發(fā) 處理卜?．．等）。 3． 3 性能 說明對(duì)該程序的全部性能要求，包括對(duì)精度、靈活性和時(shí)間特性的要求。 數(shù)量和頻度、輸入媒體、輸入數(shù)據(jù)的來源和安全保密條件等等。 3． 6 算法 詳細(xì)說明本程序所選用的算法，具體的計(jì)算公式和計(jì)算步驟。 3． 8 接口 用圖的形式說明本程序所隸屬的上一層模塊及隸屬于本程序的下一層模塊、子程序，說明參數(shù)賦值和調(diào)用方式，說明與本程序相直接關(guān)聯(lián)的數(shù)據(jù)結(jié)構(gòu)（數(shù)據(jù)庫、數(shù)據(jù)文卷）。 3． 10 注釋設(shè)計(jì) 說明準(zhǔn)備在本程序中安排的注釋，如： a． 加在模塊首部的注釋； b．加在各分枝點(diǎn)處的注釋； 對(duì)各變量的功能、范圍、缺省條件等所加的注釋； d．對(duì)使用的邏輯所加的注釋等等。 3． 12 測(cè)試計(jì)劃 說明對(duì)本程序進(jìn)行單體測(cè)試的計(jì)劃，包括對(duì)測(cè)試的技術(shù)要求、輸入數(shù)據(jù)、預(yù)期結(jié)果、進(jìn)度安排、人員職責(zé)、設(shè)備條件驅(qū)動(dòng)程序及樁模塊等的規(guī)定。 4 程序 2（標(biāo)識(shí)符）設(shè)計(jì)說明 用類似 3 的方式，說明第 2 個(gè)程序乃至第 N 個(gè)程序的設(shè)計(jì)考慮。 1． 2 背景 說明： a．這份用戶手冊(cè)所描述的軟件系統(tǒng)的名稱； b．該軟件項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶（或首批用戶）及安裝此軟件的計(jì)算中心。 1． 4 參考資料 列出有用的參考資料，如： a．項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文； b．屬于本項(xiàng)目的其他已發(fā)表文件； c．本文件中各處引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。 2 用途 2． 1 功能 結(jié)合本軟件的開發(fā)目的逐項(xiàng)地說明本軟件所具有各項(xiàng)功能以及它們的極限范圍。 2． 2． 2 時(shí)間特性 定量地說明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)間等。 2． 3 安 全保密 說明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。 b．所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)／脫機(jī)； c． I／ O 設(shè)備（聯(lián)機(jī)／脫機(jī)？）； d．?dāng)?shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。 3． 3 數(shù)據(jù)結(jié)構(gòu) 列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。 4． 1 安裝與初始化 一步一步地說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包括程序的存儲(chǔ)形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。 4． 2． 1 輸入數(shù)據(jù)的現(xiàn)實(shí)背景 說明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是 a．情況 例如人員變動(dòng)、庫存‘缺貨； b．情況出現(xiàn)的頻度 例如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù)． c．情況來源 一例如人事部門、倉庫管理部門； d．輸入媒體 例如鍵盤、穿孔卡片、磁帶； e．限制 出于安全、保密考慮而對(duì)訪問這些輸入數(shù)據(jù)所加的限制； f．質(zhì)量管理 例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等； g．支配 例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。 f．詞匯表 給出允許使用的字符組合的列表，禁止使用＊的字符組合的列表 等； g．省略和重復(fù) 給出用來表示輸人元素可省略或重復(fù)的表示方式； h．控制 給出用來表示輸入開始或結(jié)束的控制信息。 4． 3 輸出 對(duì)每項(xiàng)輸出作出說明． 軟件項(xiàng)目管理制度 作者 Page 26 8/10/2020 4． 3． 1 輸出數(shù)據(jù)的現(xiàn)實(shí)背景，說明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是： a．使用 這些輸出數(shù)據(jù)是給誰的，用來干什么； b．使用頻度 例如每周的、定期的或備查閱的； c．媒體 打印、 CRI 顯示、磁帶、卡片、磁盤， d．質(zhì)量管理 一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定； e．支配 例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。 4． 3． 3 輸出舉例 為每種輸出類型提供例子。 4． 4 文卷查詢 這一條的編寫針對(duì)具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫查詢有關(guān)的初始化、準(zhǔn)備、及處 理所需 要的詳細(xì)規(guī)定，說明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。指出為了確保再啟動(dòng)和恢 復(fù)的能力，用戶必須遵循的處理過程。 軟件項(xiàng)目管理制度 作者 Page 27 8/10/2020 附錄 45 數(shù)據(jù)要求說明書 1 引言 1． 1 編寫目的 說明編寫這份數(shù)據(jù)要求說明書的目的，指出預(yù)期的讀者。 1． 3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位。 2 數(shù)據(jù)的邏輯描述 對(duì)數(shù)據(jù)進(jìn)行邏輯描述時(shí)可把數(shù)據(jù)分為動(dòng)態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂動(dòng)態(tài)數(shù)據(jù)．包括所有在運(yùn) 行中要發(fā)生變化的數(shù)據(jù)以及在運(yùn)行中要輸入、輸出的數(shù)據(jù)。給出每一數(shù)據(jù)元的名稱（包括縮寫和代碼）、定 義（或物 理意義）度量單位、值域、格式和類型等有關(guān)信息。 2． 2 動(dòng)態(tài)輸人數(shù)據(jù) 列出動(dòng)態(tài)輸入數(shù)據(jù)元素（包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。 2． 4 內(nèi)部生成數(shù)據(jù) 列出向用戶或開發(fā)單位中的維護(hù)調(diào)試人員提供的內(nèi)部生成數(shù)據(jù)。逐條列出對(duì)進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對(duì)數(shù)據(jù)要求的限制（容 量 、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值）。 3 數(shù)據(jù)的采集 3． 1 要求和范圍 按數(shù)據(jù)元的邏輯分組來說明數(shù)據(jù)采集的要求和范圍，指明數(shù)據(jù)的采集方法，說明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。如果只有指定的輸入點(diǎn)的輸入才是合法的，則必須對(duì)此加以說明； c．接受者說明輸出數(shù)據(jù)的接 受者； d．輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。在數(shù)據(jù)是非數(shù)字量的情況下，要給出每一種合法值的形式和含意； g．更新和處理的頻度給出預(yù)定的對(duì)輸入數(shù)據(jù)的更新和處理的頻度。 3． 2 輸人的承擔(dān)者 說明預(yù)定的對(duì)數(shù)據(jù)輸入工作的承擔(dān)者。 3． 3 預(yù)處理 對(duì)數(shù)據(jù)的采集和預(yù)處理過程提出專門的規(guī)定，包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通信媒體和對(duì)輸入的時(shí)間要求等。 3． 4 影響 說明這些數(shù)據(jù)要求對(duì)于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響，例如要求用戶單位增設(shè)某個(gè)機(jī)構(gòu)等。 1． 2 背景 說明： a．本項(xiàng)目的名稱和所開發(fā)出來的軟件系統(tǒng)的名稱； b．此軟件的任務(wù)提出者、開發(fā)者、用戶及安裝此軟件的計(jì)算中心。 1． 4 參考資料 列出要用到的參考資料，如： a．本項(xiàng)目的已核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文； b．屬于本項(xiàng)目的其他已發(fā)表 的文件； c．本文件中各處所引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。 2 實(shí)際開發(fā)結(jié)果 2． 1 產(chǎn)品 說明最終制成的產(chǎn)品，包括： a．程序系統(tǒng)中各個(gè)程序的名字，它們之間的層次關(guān)系，以千字節(jié)為單位的各個(gè)程序的程序量、存儲(chǔ)媒體的形式和數(shù)量； b．程序系統(tǒng)共有哪幾個(gè)版本，各自的版本號(hào)及它們之間的區(qū)別； c．每個(gè)文件的名稱； d．所建立的每個(gè)數(shù)據(jù)庫。 2． 2 主要功能和性能 逐項(xiàng)列出本軟件產(chǎn)品所實(shí)際具有的主要功能和性能，對(duì)照可行性研究報(bào)告、項(xiàng)目開發(fā)計(jì)劃、功能需 ．求說明書的有關(guān)內(nèi)容，說明原定的開發(fā)目標(biāo)是達(dá)到了、未完全達(dá)到、或超過了。 2． 4 進(jìn)度 列出原定計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比，明確說明，實(shí)際進(jìn)度是提前了、還是延遲了，分析主要原因。 明確說明，經(jīng)費(fèi)是超出了、還是節(jié)余了，分析其主要原因。 3． 2 對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià) 說明在測(cè)試中檢查出來的程序編制中的錯(cuò)誤發(fā)生率，即每干條指令（或語句）中的錯(cuò)誤指令數(shù)（或語句數(shù)）。 3． 3 對(duì)技術(shù)方法的評(píng)價(jià) 給出對(duì)在開發(fā)中所使用的技術(shù)、方法、工具、手段的評(píng)價(jià)。 4 經(jīng)驗(yàn)與教訓(xùn) 列出從這項(xiàng)開發(fā)工作中所得到的最主要的經(jīng)驗(yàn)與教訓(xùn)及對(duì)今后的項(xiàng)目開發(fā)工作的建議。 命名一般以簡(jiǎn)介單詞構(gòu)成。 package class 的命名 class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成 ,對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。后面的單詞用大寫字母開頭 userName , thisAClassMethod static final 變 量的命名 static final 變量的名字應(yīng)該都大寫，并且指出完整含義。 參數(shù)的命名 參數(shù)的名字必須和變量的命名規(guī)范一致。 軟件項(xiàng)目管理制度 作者 Page 32 8/10/2020 而不是： byte buffer[]。 } 注視規(guī)范 Java 的注釋有三 種 // 注釋一行 /* ...... */ 注釋若干行 /** ...... */ 注釋若干行，并寫入 javadoc 文檔 ，也叫 java 文檔注釋 注釋要簡(jiǎn)單明了。 //用戶名 邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。注釋的內(nèi)容要清楚、明了 ，含義準(zhǔn)確，防止注釋二義性。 對(duì)代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。 變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。 軟件項(xiàng)目管理制度 作者 Page 33 8/10/2020 在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi) 部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過程清單及本文件歷史修改記錄等。 What is modified * 1. David Li new **/ 在每個(gè)函數(shù)或過程的前面要有必要的注釋信息，包括：函數(shù)或過程名稱；功能描述；輸入、輸出及返回值說明；調(diào)用關(guān)系及被調(diào)用關(guān)系說明等 /** * Description :checkout 提款 * param Hashtable cart info * param OrderBean order info * return String */ public String checkout(Hashtable htCart, OrderBean orderBean)