【正文】 軟件的計(jì)算過(guò)程中得到 c．特性 輸出的值域、計(jì)量單位、在什么情況下可缺省等。 4． 4 文卷查詢 這一條的編寫針對(duì)具有查詢能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫(kù)查詢有關(guān)的初始化、準(zhǔn)備、及處 理所需 要的詳細(xì)規(guī)定，說(shuō)明查詢的能力、方式，所使用的命令和所要求的控制規(guī)定。 4． 5 出錯(cuò)處理和恢復(fù) 列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。指出為了確保再啟動(dòng)和恢 復(fù)的能力，用戶必須遵循的處理過(guò)程。 4． 6 終端操作 當(dāng)軟件是在多終端系統(tǒng)上工作時(shí)，應(yīng)編寫本條，以說(shuō)明終端的配置安排、連接步釋、數(shù)據(jù)和參數(shù)輸入 步驟以及控制規(guī)定．說(shuō)明通過(guò)終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文卷的能力、語(yǔ)言、過(guò)程以及輔助性程 序等。 軟件項(xiàng)目管理制度 作者 Page 27 8/10/2020 附錄 45 數(shù)據(jù)要求說(shuō)明書 1 引言 1． 1 編寫目的 說(shuō)明編寫這份數(shù)據(jù)要求說(shuō)明書的目的，指出預(yù)期的讀者。 1． 2 背景 說(shuō)明： a．待開發(fā)軟件系統(tǒng)的名稱； b．列出本項(xiàng)目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項(xiàng)軟件的計(jì)算站（中心）或計(jì)算機(jī)網(wǎng)絡(luò)系統(tǒng)。 1． 3 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。 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)。列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位。說(shuō)明能夠得到這些文件資料的來(lái)源。 2 數(shù)據(jù)的邏輯描述 對(duì)數(shù)據(jù)進(jìn)行邏輯描述時(shí)可把數(shù)據(jù)分為動(dòng)態(tài)數(shù)據(jù)和靜態(tài)數(shù)據(jù)。所謂靜態(tài)數(shù)據(jù)，指在運(yùn)行過(guò)程中主要作 為參考的數(shù)據(jù)，它們?cè)诤荛L(zhǎng)的一段時(shí)間內(nèi)不會(huì)變化，一般不隨運(yùn)行而改變。所謂動(dòng)態(tài)數(shù)據(jù)．包括所有在運(yùn) 行中要發(fā)生變化的數(shù)據(jù)以及在運(yùn)行中要輸入、輸出的數(shù)據(jù)。進(jìn)行描述時(shí)應(yīng)把各數(shù)據(jù)元素邏輯地分成若干 組，列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)倪壿嫹纸M。給出每一數(shù)據(jù)元的名稱（包括縮寫和代碼）、定 義（或物 理意義）度量單位、值域、格式和類型等有關(guān)信息。 2． 1 靜態(tài)數(shù)據(jù) 列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。 2． 2 動(dòng)態(tài)輸人數(shù)據(jù) 列出動(dòng)態(tài)輸入數(shù)據(jù)元素（包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。 2． 3 動(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ù)。 2． 5 數(shù)據(jù)約定 說(shuō)明對(duì)數(shù)據(jù)要求的制約。逐條列出對(duì)進(jìn)一步擴(kuò)充或使用方面的考慮而提出的對(duì)數(shù)據(jù)要求的限制（容 量 、文卷、記錄和數(shù)據(jù)元的個(gè)數(shù)的最大值）。對(duì)于在設(shè)計(jì)和開發(fā)中確定是臨界性的限制更要明確指出。 3 數(shù)據(jù)的采集 3． 1 要求和范圍 按數(shù)據(jù)元的邏輯分組來(lái)說(shuō)明數(shù)據(jù)采集的要求和范圍，指明數(shù)據(jù)的采集方法，說(shuō)明數(shù)據(jù)采集工作的承擔(dān)者是用戶還是開發(fā)者。具體的內(nèi)容包括： a．輸入數(shù)據(jù)的來(lái)源，例如是單個(gè)操作員、數(shù)據(jù)輸入站，專業(yè)的數(shù)據(jù)輸入公司或它們的軟件項(xiàng)目管理制度 作者 Page 28 8/10/2020 一個(gè)分組； b．?dāng)?shù)據(jù)輸入（指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和硬設(shè)備。如果只有指定的輸入點(diǎn)的輸入才是合法的，則必須對(duì)此加以說(shuō)明； c．接受者說(shuō)明輸出數(shù)據(jù)的接 受者； d．輸出數(shù)據(jù)的形式和設(shè)備列出輸出數(shù)據(jù)的形式和硬設(shè)備。無(wú)論接受者將接收到的數(shù)據(jù)是打印輸出，還是 CRT 上的一組字符、一幀圖形，或一聲警鈴，或向開關(guān)線圈提供的一個(gè)電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng)具體說(shuō)明； e．?dāng)?shù)據(jù)值的范圍給出每一個(gè)數(shù)據(jù)元的合法值的范圍； f．量綱給出數(shù)字的度量單位、增量的步長(zhǎng)、零點(diǎn)的定標(biāo)等。在數(shù)據(jù)是非數(shù)字量的情況下，要給出每一種合法值的形式和含意； g．更新和處理的頻度給出預(yù)定的對(duì)輸入數(shù)據(jù)的更新和處理的頻度。如果數(shù)據(jù)的輸入是隨機(jī)的，應(yīng)給出更新處理的頻度的 平均值，或變化情況的某種其他度量。 3． 2 輸人的承擔(dān)者 說(shuō)明預(yù)定的對(duì)數(shù)據(jù)輸入工作的承擔(dān)者。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，還應(yīng)說(shuō)明該接口軟件的來(lái)源。 3． 3 預(yù)處理 對(duì)數(shù)據(jù)的采集和預(yù)處理過(guò)程提出專門的規(guī)定，包括適合應(yīng)用的數(shù)據(jù)格式、預(yù)定的數(shù)據(jù)通信媒體和對(duì)輸入的時(shí)間要求等。對(duì)于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量，要給出轉(zhuǎn)換方法和轉(zhuǎn)換因子等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。 3． 4 影響 說(shuō)明這些數(shù)據(jù)要求對(duì)于設(shè)備、軟件、用戶、開發(fā)單位所可能產(chǎn)生的影響，例如要求用戶單位增設(shè)某個(gè)機(jī)構(gòu)等。 軟件項(xiàng)目管理制度 作者 Page 29 8/10/2020 附錄 46 項(xiàng)目開發(fā)總結(jié)報(bào)告 I 引言 1． 1 編寫目的 說(shuō)明編寫這份項(xiàng)目開發(fā)總結(jié)報(bào)告的目的，指出預(yù)期的閱讀范圍。 1． 2 背景 說(shuō)明： a．本項(xiàng)目的名稱和所開發(fā)出來(lái)的軟件系統(tǒng)的名稱； b．此軟件的任務(wù)提出者、開發(fā)者、用戶及安裝此軟件的計(jì)算中心。 I． 3 定義 列出本文件中用到的專門術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。 1． 4 參考資料 列出要用到的參考資料，如： a．本項(xiàng)目的已核準(zhǔn)的計(jì)劃任務(wù)書或合同、上級(jí)機(jī)關(guān)的批文； b．屬于本項(xiàng)目的其他已發(fā)表 的文件； c．本文件中各處所引用的文件、資料，包括所要用到的軟件開發(fā)標(biāo)準(zhǔn)。 列出這些文件的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠得到這些文件資料的來(lái)源。 2 實(shí)際開發(fā)結(jié)果 2． 1 產(chǎn)品 說(shuō)明最終制成的產(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ù)庫(kù)。 如果開發(fā)中制訂過(guò)配置管理計(jì)劃，要同這個(gè)計(jì) 劃相比較。 2． 2 主要功能和性能 逐項(xiàng)列出本軟件產(chǎn)品所實(shí)際具有的主要功能和性能，對(duì)照可行性研究報(bào)告、項(xiàng)目開發(fā)計(jì)劃、功能需 ．求說(shuō)明書的有關(guān)內(nèi)容，說(shuō)明原定的開發(fā)目標(biāo)是達(dá)到了、未完全達(dá)到、或超過(guò)了。 2． 3 基本流程 用圖給出本程序系統(tǒng)的實(shí)際的基本的處理流程。 2． 4 進(jìn)度 列出原定計(jì)劃進(jìn)度與實(shí)際進(jìn)度的對(duì)比，明確說(shuō)明，實(shí)際進(jìn)度是提前了、還是延遲了，分析主要原因。 2． 5 費(fèi)用 列出原定計(jì)劃費(fèi)用與實(shí)際支出費(fèi)用的對(duì)比，包括： a．工時(shí)，以人月為單位，并按不同級(jí)別統(tǒng)計(jì)； b．計(jì) 算機(jī)的使用時(shí)間，區(qū)別 CPU 時(shí)間及其他設(shè)備時(shí)間； c．物料消耗、出差費(fèi)等其他支出。 明確說(shuō)明，經(jīng)費(fèi)是超出了、還是節(jié)余了，分析其主要原因。 3 開發(fā)工作評(píng)價(jià) 3． 1 對(duì)生產(chǎn)效率的評(píng)價(jià) 軟件項(xiàng)目管理制度 作者 Page 30 8/10/2020 給出實(shí)際生產(chǎn)效率，包括： a．程序的平均生產(chǎn)效率，即每人月生產(chǎn)的行數(shù)； b．文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字?jǐn)?shù)； 并列出原訂計(jì)劃數(shù)作為對(duì)比。 3． 2 對(duì)產(chǎn)品質(zhì)量的評(píng)價(jià) 說(shuō)明在測(cè)試中檢查出來(lái)的程序編制中的錯(cuò)誤發(fā)生率，即每干條指令（或語(yǔ)句）中的錯(cuò)誤指令數(shù)（或語(yǔ)句數(shù)）。如果開發(fā)中制訂過(guò) 質(zhì)量保證計(jì)劃或配置管理計(jì)劃，要同這些計(jì)劃相比較。 3． 3 對(duì)技術(shù)方法的評(píng)價(jià) 給出對(duì)在開發(fā)中所使用的技術(shù)、方法、工具、手段的評(píng)價(jià)。 3． 4 出錯(cuò)原因的分析 給出對(duì)于開發(fā)中出現(xiàn)的錯(cuò)誤的原因分析。 4 經(jīng)驗(yàn)與教訓(xùn) 列出從這項(xiàng)開發(fā)工作中所得到的最主要的經(jīng)驗(yàn)與教訓(xùn)及對(duì)今后的項(xiàng)目開發(fā)工作的建議。 軟件項(xiàng)目管理制度 作者 Page 31 8/10/2020 附錄 51 JAVA 編碼規(guī)范 命名規(guī)范 定義這個(gè)規(guī)范的目的是讓項(xiàng)目中所有的文檔都看起來(lái)像一個(gè)人寫的，增加可讀性，減少項(xiàng)目組中因?yàn)閾Q人而帶來(lái)的損失。 命名一般以簡(jiǎn)介單詞構(gòu)成。 package 的命名 package 的名字應(yīng)該都是由一個(gè)小寫單詞組成。 package class 的命名 class 的名字必須由大寫字母開頭而其他字母都小寫的單詞組成 ,對(duì)于所有標(biāo)識(shí)符，其中包含的所有單詞都應(yīng)緊靠在一起，而且大寫中間單詞的首字母。 public class ThisAClassName{} class 變量的命名 變量的名字必須用一個(gè)小寫字母開頭。后面的單詞用大寫字母開頭 userName , thisAClassMethod static final 變 量的命名 static final 變量的名字應(yīng)該都大寫，并且指出完整含義。 public static final String DB_CONFIG_FILE_PATH =。 參數(shù)的命名 參數(shù)的名字必須和變量的命名規(guī)范一致。 數(shù)組的命名 數(shù)組應(yīng)該總是用下面的方式來(lái)命名： byte[] buffer。 軟件項(xiàng)目管理制度 作者 Page 32 8/10/2020 而不是： byte buffer[]。 方法的參數(shù) 使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字 段一樣的名字： setCounter(int size){ = size。 } 注視規(guī)范 Java 的注釋有三 種 // 注釋一行 /* ...... */ 注釋若干行 /** ...... */ 注釋若干行，并寫入 javadoc 文檔 ，也叫 java 文檔注釋 注釋要簡(jiǎn)單明了。 String userName = null。 //用戶名 邊寫代碼邊注釋，修改代碼同時(shí)修改相應(yīng)的注釋，以保證注釋與代碼的一致性。 在必要的地方注釋，注釋量要適中。注釋的內(nèi)容要清楚、明了 ，含義準(zhǔn)確，防止注釋二義性。保持注釋與其描述的代碼相鄰，即注釋的就近原則。 對(duì)代碼的注釋應(yīng)放在其上方相鄰位置，不可放在下面。對(duì)數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對(duì)結(jié)構(gòu)中的每個(gè)域的注釋應(yīng)放在此域的右方； 同一結(jié)構(gòu)中不同域的注釋要對(duì)齊。 變量、常量的注釋應(yīng)放在其上方相鄰位置或右方。 全局變量要有較詳細(xì)的注釋，包括對(duì)其功能、取值范圍、哪些函數(shù)或過(guò)程存取它以及存取時(shí)注意事項(xiàng)等的說(shuō)明。 軟件項(xiàng)目管理制度 作者 Page 33 8/10/2020 在每個(gè)源文件的頭部要有必要的注釋信息，包括：文件名；版本號(hào)；作者；生成日期；模塊功能描述（如功能、主要算法、內(nèi) 部各部分之間的關(guān)系、該文件與其它文件關(guān)系等）；主要函數(shù)或過(guò)程清單及本文件歷史修改記錄等。 /** * Copy Right Information : stsoft * Project : jscbmis * JDK version used : * Comments : config path * Version : * Modification history : * Sr Date Modified By Why amp。 What is modified * 1. David Li new **/ 在每個(gè)函數(shù)或過(guò)程的前面要有必要的注釋信息，包括：函數(shù)或過(guò)程名稱；功能描述；輸入、輸出及返回值說(shuō)明；調(diào)用關(guān)系及被調(diào)用關(guān)系說(shuō)明等 /** * Description :checkout 提款 * @param Hashtable cart info * @param OrderBean order info * @return String */ public String checkout(Hashtable htCart, OrderBean orderBean)