【正文】 ，如果有的話 . 限制 簡要說明程序的限制，例如數(shù)組長度，算法等等，同時給出對未來版本的建議，如果沒有限制，給出“ none” 錯誤信息 描述出錯信息或在出錯時變量的置值，如果沒有的話給出“ none” . 方法 簡單描述程序中所有調(diào)用的算法及方法，如果方法很明顯，則刪去這一項，如果應用了復雜的算法或方程式，請給出解釋及參考 . 外部變量描述 僅列出及描述那些一般不為人所知的變量，如果該函數(shù)不用任何外部變量，給出“ none” . 局部、靜態(tài)、寄存器變量描述 列出及描述局部， 靜態(tài)寄存器變量，如果一個變量的用途可從其它變量名中明顯地看到，則不必給出解釋，變量名按字典順序列出 . /*********************************************************** * 本程序屬于 XXXXXXXXX(公司名 ).作為商品機密 * * 版權所有 ,未經(jīng)許可不得公布或使用 . * ************************************************************ . 目的 函數(shù)的功能描述 . 版本狀態(tài) 11790(程序員姓名 )新代碼 . 輸入 列出所有輸入變量和解釋 . 輸出 列出所有輸出變量／參數(shù)／返回值及解釋 . 限制 給出使用的算法和處理方法 . 錯誤信息 描述錯誤信息 . 方法 該函數(shù)中用的算法和處理方法 . 函數(shù)調(diào)用 列出調(diào)用的函數(shù) . 外部變量 描述所有使用的外部變量 . 局部變量 描述局部 變量 . */ 圖 D1 C標準格式 (in “ ” ) 改舊代碼 在函數(shù)頭上的所有必要的信息必須修改 , 版本狀態(tài)必須包含版本日期 , 程序員姓名 , 以及版本的簡要描述 , 這種描述必須規(guī)格化 , 而且要包含足夠的信息 , 以便于對這些修改進行回溯 . 版本狀態(tài)列出的順序必須使得最新的版本列在最上邊 . 所有其它的信息包括輸入、輸出、限制、以及函數(shù)調(diào)用等等 , 必須與最新的版本保持一致 . 編程常規(guī) 下面說明了 C語言指令中的標準結構 : 程序設計風格 ? 通過空格和空行 , 使程序有層次感 , 便于閱讀 . ? 提倡使用 C++的語法和程序結構 . ? 所有代碼必須是小寫字符 , 以下的例外 : 1。 (1) plong=(long *)(buf+2)。..._ ... ? 如果注釋太長 , 超出一行 ,應將其按如下格式放在語句之前 : 。xxxxx ? 在語句后的注釋必須與語句在同一行 : statement 。 long *plong。它們都應對準符號的中心。 循環(huán)界限 循環(huán)界限由上界限和下界限構成，分別表示循環(huán)的開始和結束。 關鍵的技術和難點 描述開發(fā)該系統(tǒng)采用的關鍵技術和難點，對關鍵技術和難點作出風險評估，要求作出相應的解決對策， 或提出其他的解決方案。委派他人對提交的文檔進行抽查，驗證其正確性和完備性。 項目負責人 (軟件負責人 )負責組織： a、制定項目開發(fā)計劃，若軟件、硬件相結合的，其計劃也可合并制定。 物流部經(jīng)理負責組織項目的最終檢測。 標準檔案室管理員負責文檔的存貯、保管和處理。 軟件版本管理 應顧客需要進行軟件版本升級或修訂時，設計部門負責人確定項目負責人，組織軟件人員實施。 提交人 復制要求 說明發(fā)行版本的格式，版本載體的類型（介質(zhì)），復制的設備，復制的特殊要求 提交人 配套版本 當一個產(chǎn)品需要幾個軟件構成，必須主要與該版本配套的版本的編號，或關系用提交人 “ /”隔開，與關系用“，”隔開 測試人 不能少于兩人 測試該版本的所有人員的名單，要求簽名 附錄三： 概 要 設 計 說 明 書 概述 介紹該項目的名稱、任務提出者、提出的背景，應用的目標。 數(shù)據(jù)庫特性 詳細描述數(shù)據(jù)庫中要用到的每個數(shù)據(jù)元素，對每個數(shù)據(jù)元素可列出如下信息： ? 數(shù)據(jù)元素名 ? 同義名 ? 定義 ? 格式 ? 值域 ? 度量單位 ? 數(shù)據(jù)項名、縮寫詞和代碼 要根據(jù)記錄的規(guī)模和數(shù)量來估計數(shù)據(jù)存儲要求，并要預測數(shù)據(jù)的增長率。在圓內(nèi)注 明某一標志符，表明該流線將在具有相同標志符的另一連接符處繼續(xù)下去。常量或宏 (用 define 或 typedef 在 include文件中定義的 )必須用大寫字母 . 2。 (2) 如果 buf=0。... 。 注釋 ? 在需要明確程序含義的地方應勤于使用注釋 , 所有注釋寫成 : 。 if_else 有 else if的語句 ,應將 if提上一行 ,例如 : if( ) { ??? . } else if { ??? . } 標號 所有標號應在第一列開始 goto 除非絕對必要 , 避免使用 goto default 在 switch語句中將 default放在 case的最后 break ? 在 switch語句之外盡量少用 break. ? 在某些循環(huán)中為減少代碼層次可有限地使用 break 和 continue. 返回 return ? 即使不返回任何值 , 也應在函數(shù)的出口處寫上 return以示函數(shù)出口 ? 盡量在一個函數(shù)中使用一個 return, 個別情況例外 (如有多個錯誤處理時 ). 大括號 用大括號將一些語句組在一起 小括號 用 （ ） 避免操作順序的混亂 .特別要注意以下兩點的應用（通過例子來說明） ,也是程序設計中經(jīng)常不注意而犯的錯誤 ： define x y+3 (1) define x (y+3) (2) 按 (1)的定義 z=x/3〉 z=y+3/3=y+1 按 (2)的定義 z=x/3 z=(y+3)/3=y/3=1 char *buf。 ? 互連 一般情況下，流線應從符號的左邊或頂端進入，從右邊或底端離開。求值結果可在表示出口路徑的流線附近寫出 并行處理 表示同步進行兩個或兩個以上并行方式的操作。 系統(tǒng)維護設計 說明為了系統(tǒng)維護方便而在程序內(nèi)部設計中作出的安排，如在程序中專門安排用于系統(tǒng)的檢查與維護的檢測點和專用模塊。 5. 批準： 審查該版本是否可以發(fā)行。 設計部門負責人審批各項目負責人資格，并負責： a、考核各階段的進度完成情況； b、及時協(xié)調(diào)開發(fā)中組織接口及計劃修改； c、控制項目開發(fā)各階段的設計輸入、設計輸出、技術狀態(tài)和各階段的驗 證 ,并對軟件的正確性、文檔的完 整性負責。 技術發(fā)展部負責組織對公司下達的軟件項目進行各階段的評審。 5 工作程序與要求 公司下達的軟件項目立項后，由技術發(fā)展部下達 [新產(chǎn)品研制任務書 ]。 軟件負責人發(fā)出 [版本送檢（啟用）通知單 ]升級的版本由物流部組織檢測合格后，由軟件負責人將新版本存入標準檔案室；并在 [版本檔案 ]中詳細記錄升級內(nèi)容，存入項目檔案中。 功能和性能 對照軟件需求說明書，來說明系統(tǒng)是如何滿足功能和性能需求的。 故障處理 列出在該系統(tǒng)出現(xiàn)故障時，為滿足信息處理要求而可能采取的技術措施，如： ? 后備技術 ? 低效技術 ? 再啟動技術 接口 說明該軟件系統(tǒng)與其他系統(tǒng)和子系統(tǒng)的接口 軟件接口和硬件接口 安全和保密 說明該軟件系統(tǒng)在安全和保密方面的要求 交付方式 交付的內(nèi)容 全部的設計文件、發(fā)行版本、源程序 交付的媒體介質(zhì) 紙質(zhì)文件、電子文件、 CD、 FLASH、軟盤 附錄五： 軟 件 開 發(fā) 規(guī) 范 軟件開發(fā)的流程和需要的文檔資料同項目開發(fā)類似，在第 章中有詳細的描述，在這不再作介紹了，僅介紹與軟件緊密相關的常用文檔資料的格式模板，以及編程設計中的若干規(guī)定 常用文檔的格式模板 流程圖 概述 國家標準 GB152689《信息處理 — 數(shù)據(jù)流程圖、程序流程圖、系統(tǒng)流程圖、程序網(wǎng)絡圖和系統(tǒng)資源圖的文件編制符號及約定》規(guī)定了信息處理文件使用的各種符號及其使用 的具體約定。