【正文】 (公共的宏定義和結(jié)構(gòu)定義 ) .DOC (文檔 ) .LIB (函數(shù)庫(kù) ) .BAT (批處理文件 ) .DAT (數(shù)據(jù)文 件 ) .ROM (燒入 EPROM的數(shù)據(jù)，在前綴中應(yīng)該指明芯片對(duì)應(yīng)的插座 ) ? 使用 make, Makefile 進(jìn)行編譯 , 更新目標(biāo)文件和可執(zhí)行文件 . 子過程名 子過程名的長(zhǎng)度沒有限制 . 但各個(gè)名稱的前 31個(gè)字符必須唯一 .(各系統(tǒng)的狀態(tài)會(huì)有變化 , 盡可能在開始時(shí)加以區(qū)分 ).建議用英文語(yǔ)句的一般風(fēng)格命名過程名 . 英文單詞的首字母大寫，后面的字母小寫。 注釋 ? 在需要明確程序含義的地方應(yīng)勤于使用注釋 , 所有注釋寫成 : 。... 。它們必須一行行地進(jìn)行說明，例如 : bxxxx DB ? 。... 。..._ ... statement 。對(duì)于外部 (公共 )變量或函數(shù)名 ,在第一個(gè)字符之前加 _,對(duì)局部的變量名 , 建議遵照下列格式 : bxxx_ 或 xxxx_b 字節(jié)變量 wxxx_ 或 xxxx_w 字變量 dxxx_ 或 xxxx_d 雙字變量 sbxxx 或 xxxx_sb 字節(jié)串變量 swxxx 或 xxxx_sw 字串 變量 cxxx_ 或 xxxx_c 常量 外部變量 ? 外部變量必須在模塊中以 extrn語(yǔ)句說明 .所有的外部變量集中在一起放在文件的開始處 . ? 如果不同類型的變量要組在一起 , 用結(jié)構(gòu)取代零散的變量 . 過程 引用的外部過程必須在模塊以 extrn語(yǔ)句說明 .所有的外部過程集中在一起放在外部變量之后 , 兩者之間有明顯的界限。 COMMENT . 子過程名稱 給出子過程的名稱 . 功能描述 提供一個(gè)關(guān)于子過程的簡(jiǎn)要描述，并且簡(jiǎn)要說明子過程的限制 . . 版本狀態(tài)和歷史 給出當(dāng)日的日期 ,程序員姓名 . . 入口參數(shù) 列出及描述所有該 子過程將輸入的變量和寄存器 . . 出口參數(shù) 列出及描述所有該子過程的輸出變量和寄存器 , 并列出被破壞的寄存器 . . 默認(rèn)的段寄存器和段名 用 ASSUME 指出在該子過程中，默認(rèn)的段寄存器和段名的關(guān)系。 注釋 ? 在需要明確程序 含義的地方應(yīng)勤于使用注釋 , 所有注釋寫成 :/*... ...*/或 // ? 在語(yǔ)句后的注釋必須與語(yǔ)句在同一行 : statement /*..._ ..*/ statement /*..._ ..*/ ? 如果注釋太長(zhǎng) , 超出一行 ,應(yīng)將其按如下格式放在語(yǔ)句之前 : /*... ... ... ...*/ ? 如果變量需要注釋 , 它們必須一行行地進(jìn)行說明 , 例如 : int i。 plong=(long *)buf+2。i++) ...。 寄存器變量 在程序中找一個(gè)頻繁使用的變量 (int或指針類型 ),將其定義成寄存器類以加快運(yùn)行速度，特別適用于循環(huán)變量中。該文本中說明的其它必須大寫的字母 . ? 代碼盡可能寫得簡(jiǎn)單、清晰、將復(fù)雜語(yǔ)句切成幾個(gè)簡(jiǎn)單的語(yǔ)句以增加可讀性 . ? 一般將子程序限制在 100行以內(nèi) . ? 對(duì)于一個(gè)程序只允許一個(gè)入口和出口（在有出錯(cuò)處理等情況下可能允許有若干個(gè)出口） . ? 設(shè)計(jì)的子程序必須有一個(gè)完整定義的輸出、輸入并且完成一個(gè)任務(wù) . ? 將密切相關(guān)的子程序存放在一個(gè)文件中 . ? 程序中盡量不使用直接數(shù) , 即盡量不在源程序中出現(xiàn)某個(gè)具體的數(shù)值 , 相應(yīng)的數(shù)值最好用define語(yǔ)句定義成宏 , 以便于修改和維護(hù) . ? 使用統(tǒng)一的工作環(huán)境 , 建立子目錄 , 各目錄存放指定的內(nèi)容 : src (源程序存放目錄 ) doc (文檔存放目錄 ) bin (可執(zhí)行程序存放目錄 ) lib (庫(kù)函數(shù)存放目錄 ) test (測(cè)試用目錄 ) inc (引用文件存放目錄 ) personal (各人自用目錄 ) ? 使用 make, Makefile進(jìn)行編譯 , 更新目標(biāo)文件和可執(zhí)行文件 . C 庫(kù)函數(shù) ? 僅使用 Unix System V、 Microsoft C、 Lattic C及 Turbo C 編譯器中的庫(kù)函數(shù) . ? 在用 malloc或 calloc申請(qǐng)空間之后 , 建議測(cè)試一下不為空指針，若使用空指針，通常會(huì)導(dǎo)致系統(tǒng)的崩潰，或莫名其妙的錯(cuò)誤。 ? 多出口 企業(yè) () 大量的管理資料下載 一個(gè)符號(hào)如有多個(gè)出口，應(yīng)按下述方式表示，在每個(gè)出口都應(yīng)標(biāo)有適當(dāng)?shù)臈l件值，以反映它所表示的邏輯路徑。 ? 流線的交叉 應(yīng)當(dāng)盡量避免流線的交叉，即使出現(xiàn)，交叉的流線之間沒有任何邏輯關(guān)系，不對(duì)流向產(chǎn)生影響。符號(hào)標(biāo)志符要寫在符號(hào)的左上角。 省略符 若流程圖中有些部分無需給出符號(hào)的具體形式和數(shù)量，可用省略符。 流線 表示控制流的流向 虛線 用于表明被注解的范圍或連接 被注解部分與注解正文 連接符 用于表明轉(zhuǎn)向流程圖的它處，或從它處轉(zhuǎn)入。符號(hào)內(nèi)可注明判斷的條件，它只有一個(gè)入口，但可以有若干可以選擇的出口。該處理為在另外地方已得到詳細(xì)說明的一個(gè)操作或一組操作。 要求采用 VISIO 或 SMARTDRAW 軟件繪制流程圖。 交付方式 交付的內(nèi)容 全部的設(shè)計(jì)文件、發(fā)行版本、源程序 交付的媒體介質(zhì) 紙質(zhì)文件、電子文件、 CD、 FLASH、軟盤 企業(yè) () 大量的管理資料下載 附錄四： 需 求 說 明 書 簡(jiǎn)介 介紹該項(xiàng)目的名稱、任務(wù)提出者、提出的背景，應(yīng)用的目標(biāo) 詳細(xì)需求 環(huán)境需求 硬件環(huán)境 ? 描述運(yùn)行該軟件需要的設(shè)備能力 ? 處理器的速度、數(shù)量和內(nèi)存容量 ? 存儲(chǔ)媒體的容量 ? 輸入、輸出設(shè)備的種類和數(shù) 量 ? 通訊網(wǎng)絡(luò) 軟件環(huán)境 運(yùn)行該軟件需要的操作系統(tǒng)、數(shù)據(jù)庫(kù)軟件、以及相應(yīng)的其他應(yīng)用軟件 人員環(huán)境 操作該軟件對(duì)人員的要求，人員的素質(zhì)、數(shù)量 功能需求 對(duì)系統(tǒng)中每一個(gè)功能，要求用圖示或文字詳細(xì)描述： 概述 —— 敘述功能名稱、目標(biāo)和作用 輸入 —— 詳述該功能輸入的信息 處理 —— 描述該功能作什么，如何對(duì)輸入信息進(jìn)行加工并轉(zhuǎn)換成輸出信息 輸出 —— 詳述該功能輸出的信息 內(nèi)部生成數(shù)據(jù) —— 列出用戶所關(guān)心的內(nèi)部生成數(shù)據(jù) 性能需求 定量的描述該軟件系統(tǒng)應(yīng)滿足的具體性能需求 精度 說明該軟件系統(tǒng)的精度要求，如： ? 數(shù)據(jù)的精度要求 ? 數(shù)字計(jì)算的精度要求 企業(yè) () 大量的管理資料下載 ? 數(shù)據(jù)轉(zhuǎn)送的誤碼率要求 時(shí)間特性 說明該軟件系統(tǒng)的時(shí)間要求，如： ? 解題時(shí)間 ? 詢問和更新數(shù)據(jù)文件的響應(yīng)時(shí)間 ? 系統(tǒng)各項(xiàng)功能的順序關(guān)系 ? 由于輸入類型的不同和操作方式的變化而引起的優(yōu)先順序 ? 在峰值負(fù)載期，與所規(guī)定的響應(yīng)時(shí)間的允許偏離范圍 靈活性 說明當(dāng)需求發(fā)生某些變化時(shí)該軟件系統(tǒng)的適應(yīng)能力，指出為適應(yīng)這些變化而需要設(shè)計(jì)的軟件成分和過程 輸入和輸出 描述輸入和輸出的每個(gè)數(shù)據(jù)元素，對(duì)每個(gè)數(shù)據(jù)元素可列出如下信息： ? 數(shù)據(jù)元素名 ? 同義名 ? 定義 ? 格式 ? 值域 ? 度量單位 ? 數(shù)據(jù)項(xiàng)名、縮寫詞和代碼 對(duì)于輸入數(shù)據(jù)，還 要說明時(shí)間要求、優(yōu)先順序和輸入媒體。 系統(tǒng)出錯(cuò)處理設(shè)計(jì) 出錯(cuò)信息 用表格形式列出每種可能的出錯(cuò)或故障情況出現(xiàn)時(shí)，系統(tǒng)輸出信息的形式、含義及處理方法。 接口設(shè)計(jì) 外部接口 說明該系統(tǒng)同外部所有的接口安排，包括硬件接口、軟件接口、用戶接口。 開發(fā)工具和平臺(tái) 描述采用何種操作系統(tǒng)平臺(tái)、何種編程語(yǔ)言、開發(fā)工具進(jìn)行開發(fā)。 6. 編號(hào)、錄入數(shù)據(jù)、刻盤： 光盤的卷標(biāo)為 8 位數(shù)字的序列號(hào)，在根目錄下建立以版本編號(hào)為名稱的子目錄，所有提交的文檔資料存放在該子目錄中。 3. 審核： 檢查文件的完整性和正確性。 附錄 附錄一：軟件產(chǎn)品文件表 附錄二： 版本啟用 /存檔實(shí)施細(xì)