【正文】 /** * Copy Right Information : stsoft * Project : jscbmis * JDK version used : * Comments : config path * Version : * Modification history : * Sr Date Modified By Why amp。 全局變量要有較詳細(xì)的注釋，包括對其功能、取值范圍、哪些函數(shù)或過程存取它以及存取時注意事項等的說明。對數(shù)據(jù)結(jié)構(gòu)的注釋應(yīng)放在其上方相鄰位置，不可放在下面；對結(jié)構(gòu)中的每個域的注釋應(yīng)放在此域的右方； 同一結(jié)構(gòu)中不同域的注釋要對齊。保持注釋與其描述的代碼相鄰，即注釋的就近原則。 在必要的地方注釋，注釋量要適中。 String userName = null。 方法的參數(shù) 使用有意義的參數(shù)命名，如果可能的話，使用和要賦值的字 段一樣的名字： setCounter(int size){ = size。 數(shù)組的命名 數(shù)組應(yīng)該總是用下面的方式來命名： byte[] buffer。 public static final String DB_CONFIG_FILE_PATH =。 public class ThisAClassName{} class 變量的命名 變量的名字必須用一個小寫字母開頭。 package 的命名 package 的名字應(yīng)該都是由一個小寫單詞組成。 軟件項目管理制度 作者 Page 31 8/10/2020 附錄 51 JAVA 編碼規(guī)范 命名規(guī)范 定義這個規(guī)范的目的是讓項目中所有的文檔都看起來像一個人寫的，增加可讀性，減少項目組中因為換人而帶來的損失。 3． 4 出錯原因的分析 給出對于開發(fā)中出現(xiàn)的錯誤的原因分析。如果開發(fā)中制訂過 質(zhì)量保證計劃或配置管理計劃，要同這些計劃相比較。 3 開發(fā)工作評價 3． 1 對生產(chǎn)效率的評價 軟件項目管理制度 作者 Page 30 8/10/2020 給出實際生產(chǎn)效率，包括： a．程序的平均生產(chǎn)效率，即每人月生產(chǎn)的行數(shù)； b．文件的平均生產(chǎn)效率，即每人月生產(chǎn)的千字?jǐn)?shù)； 并列出原訂計劃數(shù)作為對比。 2． 5 費(fèi)用 列出原定計劃費(fèi)用與實際支出費(fèi)用的對比，包括： a．工時，以人月為單位，并按不同級別統(tǒng)計； b．計 算機(jī)的使用時間，區(qū)別 CPU 時間及其他設(shè)備時間； c．物料消耗、出差費(fèi)等其他支出。 2． 3 基本流程 用圖給出本程序系統(tǒng)的實際的基本的處理流程。 如果開發(fā)中制訂過配置管理計劃，要同這個計 劃相比較。 列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠得到這些文件資料的來源。 I． 3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 軟件項目管理制度 作者 Page 29 8/10/2020 附錄 46 項目開發(fā)總結(jié)報告 I 引言 1． 1 編寫目的 說明編寫這份項目開發(fā)總結(jié)報告的目的，指出預(yù)期的閱讀范圍。對于需經(jīng)模擬轉(zhuǎn)換或數(shù)字轉(zhuǎn)換處理的數(shù)據(jù)量，要給出轉(zhuǎn)換方法和轉(zhuǎn)換因子等有關(guān)信息，以便軟件系統(tǒng)使用這些數(shù)據(jù)。如果輸入數(shù)據(jù)同某一接口軟件有關(guān)，還應(yīng)說明該接口軟件的來源。如果數(shù)據(jù)的輸入是隨機(jī)的，應(yīng)給出更新處理的頻度的 平均值，或變化情況的某種其他度量。無論接受者將接收到的數(shù)據(jù)是打印輸出，還是 CRT 上的一組字符、一幀圖形，或一聲警鈴，或向開關(guān)線圈提供的一個電脈沖，或常用介質(zhì)如磁盤、磁帶、穿孔卡片等，均應(yīng)具體說明； e．?dāng)?shù)據(jù)值的范圍給出每一個數(shù)據(jù)元的合法值的范圍； f．量綱給出數(shù)字的度量單位、增量的步長、零點(diǎn)的定標(biāo)等。具體的內(nèi)容包括： a．輸入數(shù)據(jù)的來源，例如是單個操作員、數(shù)據(jù)輸入站，專業(yè)的數(shù)據(jù)輸入公司或它們的軟件項目管理制度 作者 Page 28 8/10/2020 一個分組； b．?dāng)?shù)據(jù)輸入（指把數(shù)據(jù)輸入處理系統(tǒng)內(nèi)部）所用的媒體和硬設(shè)備。對于在設(shè)計和開發(fā)中確定是臨界性的限制更要明確指出。 2． 5 數(shù)據(jù)約定 說明對數(shù)據(jù)要求的制約。 2． 3 動態(tài)輸出數(shù)據(jù) 列出動態(tài)輸出數(shù)據(jù)元素（包括在常規(guī)運(yùn)行中或聯(lián)機(jī)操作中要改變的數(shù)據(jù)）。 2． 1 靜態(tài)數(shù)據(jù) 列出所有作為控制或參考用的靜態(tài)數(shù)據(jù)元素。進(jìn)行描述時應(yīng)把各數(shù)據(jù)元素邏輯地分成若干 組，列如函數(shù)、源數(shù)據(jù)或?qū)τ谄鋺?yīng)用更為恰當(dāng)?shù)倪壿嫹纸M。所謂靜態(tài)數(shù)據(jù)，指在運(yùn)行過程中主要作 為參考的數(shù)據(jù)，它們在很長的一段時間內(nèi)不會變化，一般不隨運(yùn)行而改變。說明能夠得到這些文件資料的來源。 1． 4 參考資料 列出有關(guān)的參考資料，如： a．本項目的經(jīng)核準(zhǔn)的計劃任務(wù)書或合同，上級機(jī)關(guān)的批文； b．屬于本項目的其他已發(fā)表文件； c．本文件中各處引用的文件、資料，包括所要 用到的軟件開發(fā)標(biāo)準(zhǔn)。 1． 2 背景 說明： a．待開發(fā)軟件系統(tǒng)的名稱； b．列出本項目的任務(wù)提出者、開發(fā)者、用戶以及將運(yùn)行該項軟件的計算站（中心）或計算機(jī)網(wǎng)絡(luò)系統(tǒng)。 4． 6 終端操作 當(dāng)軟件是在多終端系統(tǒng)上工作時，應(yīng)編寫本條，以說明終端的配置安排、連接步釋、數(shù)據(jù)和參數(shù)輸入 步驟以及控制規(guī)定．說明通過終端操作進(jìn)行查詢、檢索、修改數(shù)據(jù)文卷的能力、語言、過程以及輔助性程 序等。 4． 5 出錯處理和恢復(fù) 列出由軟件產(chǎn)生的出錯編碼或條件以及應(yīng)由用戶承擔(dān)的修改糾正工作。對例子中的每一項，說明： a．定義 每項輸出信息的意義和用途； b．來源 是從特定的輸入中抽出、從數(shù)據(jù)庫文卷中取出、或從軟件的計算過程中得到 c．特性 輸出的值域、計量單位、在什么情況下可缺省等。 4． 3． 2 輸出格式 給出對每一類輸出信息的解釋，主要是： a．首部 如輸出數(shù)據(jù)的標(biāo)識符，輸出日期和輸出編號； b．主體 輸出信息的主體，包括分欄標(biāo)題； c．尾部 包括累計總數(shù)，結(jié)束標(biāo)記。 H． 4． 2． 3 輸入舉例 為每個完整的輸入形式提供樣本，包括： a．控制或首部 例如用來表示輸入的種類和類型的信息，標(biāo)識符輸入日期，正文起點(diǎn)和對所用編碼的規(guī)定； b．主體 輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分； c．尾部 用來表示輸入結(jié)束的控制信息，累計字符總數(shù)等； d．省略 指出哪些輸入數(shù)據(jù)是可省略的； e．重復(fù) 指出哪些輸 入數(shù)據(jù)是重復(fù)的。 4． 2． 2 輸入格式 說明對初始輸入數(shù)據(jù)和參量的格式要求，包括語法規(guī)則和有關(guān)約定，如： a．長度 一例如字符數(shù)／行，字符數(shù)／項； b．格式基準(zhǔn) 例如以左面的邊沿為基準(zhǔn)； c．標(biāo)號 例如標(biāo)記或標(biāo)識符； d．順序 例如各個數(shù)據(jù)項的次序及位置； e．標(biāo)點(diǎn) 例如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號、字符組等。 4． 2 輸入 規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。表征安裝工作完成的測試實例等。 4 使用過程 在本章，首先用圖表的形式說明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。 3． 2 支持軟件 說明為運(yùn)行本軟件所需要的支持軟件，如： a．操作系統(tǒng)的名稱、版本號； 軟件項目管理制度 作者 Page 25 8/10/2020 b．程序語言的編譯／匯編系統(tǒng)的名稱和版本 號； c．?dāng)?shù)據(jù)庫管理系統(tǒng)的名稱和版本號； d．其他支持軟件。 3 運(yùn)行環(huán)境 3． 1 硬設(shè)備 列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如： a．處理機(jī)的型號、內(nèi)存容量 。 2． 2． 3 靈活性 說明本軟件所具有的靈活性，即當(dāng)用戶需求（如對操作方式、運(yùn)行環(huán)境、結(jié)果精度、時間特性等的要求）有某些變化時，本軟件的適應(yīng)能力。 2． 2 性能 2． 2． 1 精度 逐項說明對各項輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。 列出這些文件資料的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件資料的來源。 1． 3 定義 列出本文件中用到的專門術(shù)語的定義和外文首字母組詞的原詞組。 軟件項目管理制度 作者 Page 24 8/10/2020 附錄 44 用戶手冊 1 引言 1． 1 編寫目的 說明編寫這份用戶手冊的目的，指出預(yù)期的讀者。 3． 13 尚未解決的問題 說明在本程序的設(shè)計中尚未解決而設(shè)計者認(rèn)為在軟件完成之前應(yīng)解決的問題。 3． 11 限制條件 說明本程序運(yùn)行中所受到的限 制條件。 3． 9 存儲分配 根據(jù)需要，說明本程序的存儲分配。 3． 7 流程邏輯 軟件項目管理制度 作者 Page 23 8/10/2020 用圖表（例如流程圖、判定表等）輔以必要的說明來表示本程序的邏輯流程 。 3． 5 輸出項 給出對每一個輸出項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式，數(shù)據(jù)值的有效范圍，輸出的形式、 數(shù)量和頻度，輸出媒體、對輸出圖形及符號的說明、安全保密條件等等。 3． 4 輸人項 給出對每一個輸入項的特性，包括名稱、標(biāo)識、數(shù)據(jù)的類型和格式、數(shù)據(jù)值的有效范圍、輸入的方式。 3． 2 功能 說明該程序應(yīng)具有的功能，可采用 IPO 圖（即輸入一處理一輸出圖）的形式。 對于一個具體的模塊，尤其是層次比較低的模塊或子程序，其很多條目的內(nèi)容往往與它 所隸屬的上一層 模塊的對應(yīng)條目的內(nèi)容相同，在這種情況下，只要簡單地說明這一點(diǎn)即可。 3 程序 1（標(biāo)識符）設(shè)計說明 從本章開始，逐個地給出各個層次中的每個程序的設(shè)計考慮。 列出這些文件的標(biāo)題、文件編號、發(fā)表日期和出版單位，說明能夠取得這些文件的來源。 1． 3 定義 列出本文件中用到專門術(shù)語的定義和外文首字母組詞的原詞組。 軟件項目管理制度 作者 Page 22 8/10/2020 附錄 43 詳細(xì)設(shè)計說明書 1 引言 1． 1 編寫目的 說明編寫這份詳細(xì)設(shè)計說明書的目的，指出預(yù)期的讀者。 4． 3 接口 說明該軟件同其他軟件之間的接口、數(shù)據(jù)通信協(xié)議等。 4 運(yùn)行環(huán)境規(guī)定 4． 1 設(shè)備 列出運(yùn)行該軟件所需要的硬設(shè)備。 3． 5 故障處理要求 列出可能的軟件、硬件故障以及對各項性能而言所產(chǎn)生的后果和對故障處理的要求。對軟件的數(shù)據(jù)輸出及必須標(biāo)明的控制輸出量進(jìn)行解釋并舉例， 包括對硬拷貝報告（正常結(jié)果輸出、狀態(tài)輸出及異常輸出）以及圖形或顯示報告的描述。 對于為了提供這些靈活性而進(jìn)行的專門設(shè)計的部分應(yīng)該加以標(biāo)明。 3． 2． 2 時間特性要求 說明對于該軟件的時間特性要求，如對： 軟件項目管理制度 作者 Page 21 8/10/2020 a．響應(yīng)時間； b．更新處理時間； c．?dāng)?shù)據(jù)的轉(zhuǎn)換和傳送時間； d．解題時間； 等的要求。 3 需求規(guī)定 3． 1 對功能的規(guī)定 用列表的方式（例如 IPO 表即輸入、處理、輸出表的形式），逐項定量和定性地敘述對軟件所提出的功能要求，說明輸入什么量、經(jīng)怎樣的處理、得到什么輸出，說明軟件應(yīng)支持的終端數(shù)和應(yīng)支持的并行操作的用戶數(shù)。 | 2． 2 用戶的特點(diǎn) 列出本軟件的最終用戶的特點(diǎn)，充分說明操作人員、維護(hù)人員的教育水平和技術(shù)專長，以及本軟件的預(yù)期使甩頻度。如果本軟件產(chǎn)品是一項獨(dú)立的軟件，而且全部內(nèi)容自含，則說明這一點(diǎn)。 2 任務(wù)概述 2． 1 目標(biāo)