【正文】 軟件開(kāi)發(fā)流程規(guī)范德聯(lián)軟件有限責(zé)任公司編制人： 侯秀美 審核人： 2015 年 8 月 19 日目錄目錄 0一、概述 2二、開(kāi)發(fā)流程規(guī)范 3 系統(tǒng)軟硬件開(kāi)發(fā)環(huán)境 3 系統(tǒng)架構(gòu)（系統(tǒng)組成） 5 系統(tǒng)功能模塊設(shè)計(jì) 6 系統(tǒng)功能開(kāi)發(fā)流程圖 6 開(kāi)發(fā)修改記錄 7三、開(kāi)發(fā)代碼規(guī)范 8 文件結(jié)構(gòu) 8 文件信息聲明 8 頭文件的結(jié)構(gòu) 10 定義文件的結(jié)構(gòu) 11 頭文件的作用 12 目錄結(jié)構(gòu) 13 命名規(guī)則 13 共性原則 13 Windows變量命名規(guī)則 14 程序風(fēng)格 16 空行 17 代碼行 18 代碼行內(nèi)的空格 19 對(duì)齊 20 長(zhǎng)行拆分 22 修飾符的位置 23 注釋 23 函數(shù)設(shè)計(jì) 26 參數(shù)的規(guī)則 26 返回值的規(guī)則 27 函數(shù)內(nèi)部實(shí)現(xiàn)的規(guī)則 30 其它建議 32 使用斷言 32 引用與指針的比較 33 變量類型定義 35四、軟件測(cè)試規(guī)范 36 單元測(cè)試 36 系統(tǒng)測(cè)試 37 業(yè)務(wù)測(cè)試 38 驗(yàn)收測(cè)試 38 用戶現(xiàn)場(chǎng)測(cè)試 38五、軟件版本管理 39 39一、概述本文制定煙臺(tái)開(kāi)發(fā)區(qū)德聯(lián)軟件有限責(zé)任公司計(jì)算機(jī)軟件開(kāi)發(fā)規(guī)范文檔。本規(guī)范的目的是使公司軟件開(kāi)發(fā)項(xiàng)目階段清晰、要求明確、任務(wù)具體、編寫的代碼規(guī)范，使之規(guī)范化、系統(tǒng)化和工程化，向公司內(nèi)從事軟件開(kāi)發(fā)的工程師和管理人員提出一系列規(guī)范和要求，從而有利于開(kāi)發(fā)過(guò)程的控制和管理，提高所開(kāi)發(fā)軟件系統(tǒng)的質(zhì)量，縮短開(kāi)發(fā)時(shí)間，減少開(kāi)發(fā)和維護(hù)費(fèi)用，以保證項(xiàng)目高質(zhì)量、順利進(jìn)行。本規(guī)范包含：開(kāi)發(fā)流程規(guī)范和開(kāi)發(fā)代碼規(guī)范等，開(kāi)發(fā)流程規(guī)范需要技術(shù)開(kāi)發(fā)人員編寫相關(guān)內(nèi)容，希望每個(gè)技術(shù)人員形成習(xí)慣，如有新的內(nèi)容更新會(huì)及時(shí)通知大家，如有好的規(guī)范要求也可通知編制人員及時(shí)更新。本規(guī)范為煙臺(tái)開(kāi)發(fā)區(qū)德聯(lián)軟件有限責(zé)任公司內(nèi)部材料，嚴(yán)禁其他商業(yè)應(yīng)用。二、開(kāi)發(fā)流程規(guī)范 接受開(kāi)發(fā)任務(wù)，詳細(xì)閱讀軟件技術(shù)規(guī)范或技術(shù)文檔，如對(duì)技術(shù)文檔有疑義或者不清楚的地方及時(shí)與項(xiàng)目總工或用戶溝通，根據(jù)文檔和溝通內(nèi)容編寫項(xiàng)目開(kāi)發(fā)計(jì)劃，必須包括但不限于系統(tǒng)軟硬件開(kāi)發(fā)環(huán)境、系統(tǒng)架構(gòu)、系統(tǒng)功能模塊設(shè)計(jì)、系統(tǒng)功能開(kāi)發(fā)流程圖、開(kāi)發(fā)修改記錄。 系統(tǒng)軟硬件開(kāi)發(fā)環(huán)境開(kāi)發(fā)環(huán)境的搭建，最好形成文檔，便于以后同樣工作的使用。開(kāi)發(fā)人員要明確系統(tǒng)開(kāi)發(fā)擬采用的數(shù)據(jù)庫(kù)、操作系統(tǒng)、開(kāi)發(fā)語(yǔ)言、開(kāi)發(fā)工具、服務(wù)器等（具體到版本）。明確整個(gè)系統(tǒng)開(kāi)發(fā)工作流程，至少應(yīng)該包括以下流程。 系統(tǒng)架構(gòu)（系統(tǒng)組成）確定系統(tǒng)整體體系架構(gòu)，各層次之間的數(shù)據(jù)流的連接，確定軟件服務(wù)器的硬件配置及用戶硬件資源配置， 確定與用戶軟件平臺(tái)的統(tǒng)一協(xié)調(diào)。 開(kāi)發(fā)人員在繪制架構(gòu)圖時(shí)給出基本框架，能反映出基本意義即可，可以直接用文字代替例子中的圖片。圖1 系統(tǒng)邏輯架構(gòu)圖舉例圖2 物理架構(gòu)圖舉例 系統(tǒng)功能模塊設(shè)計(jì)給出系統(tǒng)的主要功能模塊，每個(gè)模塊所包含的功能。圖3 圖書管理系統(tǒng)模塊規(guī)劃圖舉例 系統(tǒng)功能開(kāi)發(fā)流程圖給出系統(tǒng)主要功能的業(yè)務(wù)流程圖。圖4 系統(tǒng)功能業(yè)務(wù)流程圖舉例 開(kāi)發(fā)修改記錄1. 開(kāi)發(fā)代碼做好備份（可以在完成一個(gè)重大功能之后，或者按時(shí)間周期性進(jìn)行備份），以免由于不可抗力導(dǎo)致代碼不可修復(fù)。（改動(dòng)的具體細(xì)節(jié)），修改前的版本要及時(shí)備份，可以方面隨時(shí)還原系統(tǒng)。修改日期修改內(nèi)容是否備份備注三、開(kāi)發(fā)代碼規(guī)范 在研究項(xiàng)目團(tuán)隊(duì)協(xié)作開(kāi)發(fā)的情況下（這里的團(tuán)隊(duì)協(xié)作也適合于應(yīng)用項(xiàng)目的開(kāi)發(fā)），編程時(shí)應(yīng)該強(qiáng)調(diào)的一個(gè)重要方面是程序的易讀性，在保證軟件速度等性能指標(biāo)能滿足用戶需求的情況下，能讓其他程序員容易讀懂你所編寫的程序。若研究項(xiàng)目小組的所有開(kāi)發(fā)人員都遵循統(tǒng)一的、鮮明的一套編程風(fēng)格，可以讓協(xié)作者、后繼者和自己一目了然，在很短的時(shí)間內(nèi)看清楚程序結(jié)構(gòu)，理解設(shè)計(jì)的思路，大大提高代碼的可讀性、可重用性、程序健壯性、可移植性、可維護(hù)性。 制定本編程規(guī)范的目的是為了提高軟件開(kāi)發(fā)效率及所開(kāi)發(fā)軟件的可維護(hù)性，提高軟件的質(zhì)量。本規(guī)范由程序風(fēng)格、命名規(guī)范、注釋規(guī)范、程序健壯性、可移植性、錯(cuò)誤處理以及軟件的模塊化規(guī)范等部分組成。 此規(guī)范以C/C++程序設(shè)計(jì)討論。 文件結(jié)構(gòu) 每個(gè)C++/C程序通常分為兩個(gè)文件。一個(gè)文件用于保存程序的聲明（declaration），稱為頭文件。另一個(gè)文件用于保存程序的實(shí)現(xiàn)（implementation），稱為定義（definition）文件。 C++/C程序的頭文件以“.h”為后綴，C程序的定義文件以“.c”為后綴，C++程序的定義文件通常以“.cpp”為后綴（也有一些系統(tǒng)以“.cc”或“.cxx”為后綴）。 文件信息聲明文件信息聲明位于頭文件和定義文件的開(kāi)頭（參見(jiàn)示例31），主要內(nèi)容有：（1） 版權(quán)信息；（2） 文件名稱，項(xiàng)目代碼，摘要，參考文獻(xiàn)；（3） 當(dāng)前版本號(hào)，作者/修改者，完成日期；（4） 版本歷史信息；（5） 主要函數(shù)描述。////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright (c) 2015, DeLianSoftCompany YanTai// All rights reserved.//// Filename ：// Project Code ：The project code about this file// Abstract ：Describe the content of this file summarily// Reference ：......//// Version ：// Author ：the name of author(mender)// Acplished date ： September 2, 2004//// Replaced version : // Original Author : the name of original author(mender)// Acplished date : September 10, 2003//// Main functions ：// Function 1 Return code Function name(Parameter Explain)// Function 2 Return code Function name(Parameter Explain)// ...// Function n Return code Function name(Parameter Explain)////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////示例31 文件信息聲明☆ 【】 文件信息聲明以兩行斜杠開(kāi)始，以兩行斜杠結(jié)束，每一行都以兩個(gè)斜杠開(kāi)始；☆ 【】 文件信息聲明包含五個(gè)部分，各部分之間以一空行間隔；☆ 【】 在主要函數(shù)部分描述了文件所包含的主要函數(shù)的聲明信息，如果是頭文件，這一部分是可以省略的。 頭文件的結(jié)構(gòu)頭文件由三部分內(nèi)容組成： (1) 頭文件開(kāi)頭處的文件信息聲明(參見(jiàn)示例31)；(2) 預(yù)處理塊；(3) 函數(shù)和類結(jié)構(gòu)聲明等。假設(shè)頭文件名稱為 ，頭文件的結(jié)構(gòu)參見(jiàn)示例32。☆ 【】 為了防止頭文件被重復(fù)引用，應(yīng)當(dāng)用ifndef/define/endif結(jié)構(gòu)產(chǎn)生預(yù)處理塊；“ifndef”或者“define”后以TAB鍵代替SPACE鍵做空格；如果頭文件名稱是由多個(gè)單詞組成，則各單詞間以下劃線“_”連接，例如有頭文件名稱為“”，則定義如下：“ifndef _FILE_SYSTEM_H_”；☆ 【】 用 include 格式來(lái)引用標(biāo)準(zhǔn)庫(kù)的頭文件(編譯器將從標(biāo)準(zhǔn)庫(kù)目錄開(kāi)始搜索)；☆ 【】 用 include “” 格式來(lái)引用非標(biāo)準(zhǔn)庫(kù)的頭文件(編譯器將從用戶的工作目錄開(kāi)始搜索)；☆ 【】 頭文件中只存放“聲明”而不存放“定義”；☆ 【】 頭文件中應(yīng)包含所有定義文件所定義的函數(shù)聲明，如果一個(gè)頭文件對(duì)應(yīng)多個(gè)定義文件，則不同定義文件內(nèi)實(shí)現(xiàn)的函數(shù)要分開(kāi)聲明，并作注釋以解釋所聲明的函數(shù)從屬于那一個(gè)定義文件；☆ 【】 宏定義和函數(shù)聲明分離，在兩個(gè)頭文件中定義，如果沒(méi)有類成員函數(shù)，可以將類和結(jié)構(gòu)的定義與函數(shù)聲明分離，也就是說(shuō)一個(gè)頭文件專用于宏定義，一個(gè)頭文件專用于類和結(jié)構(gòu)的定義，一個(gè)頭文件專用于函數(shù)聲明；☆ 【】 在C++ 語(yǔ)法中，類的成員函數(shù)可以在聲明的同時(shí)被定義，并且自動(dòng)成為內(nèi)聯(lián)函數(shù)。這雖然會(huì)帶來(lái)書寫上的方便，但卻造成了風(fēng)格不一致，弊大于利。建議將成員函數(shù)的定義與聲明分開(kāi)，不論該函數(shù)體有多么小。頭文件的結(jié)構(gòu)如下：//文件信息聲明見(jiàn)示例31，此處省略。ifndef _FILE_SYSTEM_H_ //avoid referencing the file repeatdefine _FILE_SYSTEM_H_include //reference standard head file…include “” //reference nonstandard head file…void Function1(…)。 //global function declare…class CBox //class structure decalre{…}。endif示例32 C++/C頭文件的結(jié)構(gòu) 定義文件的結(jié)構(gòu)定義文件有三部分內(nèi)容：(1) 定義文件開(kāi)頭處的文件信息聲明(參見(jiàn)示例31)；(2) 對(duì)一些頭文件的引用；(3) 程序的實(shí)現(xiàn)體（包括數(shù)據(jù)和代碼）。假設(shè)定義文件的名稱為 ，定義文件的結(jié)構(gòu)參見(jiàn)示例33。//文件信息聲明見(jiàn)示例31，此處省略。include “” //reference a head file…//global function realizationvoid Function1(…){…}//class member function realizationvoid CBox::Draw(…){…}示例33