4軟件產(chǎn)品命名規(guī)范

1、文件編號(hào)：北京易華錄信息技術(shù)股份有限公司質(zhì)量管理體系文件軟件產(chǎn)品命名規(guī)范編寫：樊平審核：李艷東批準(zhǔn)：李艷東實(shí)施日期：2009-2-1受控狀態(tài)：受控發(fā)放編號(hào)：文件會(huì)簽部門會(huì)簽人日期部門會(huì)簽人日期智能交通技術(shù)研究院李艷東北京易華錄信息技術(shù)股份有限公司二零零九年修改記錄支術(shù)股份有限公司日期版本說明修改人增加“公司名稱屬性的命名”樊平1.目的為了確保公司各個(gè)軟件產(chǎn)品及程序的正確性、統(tǒng)一性，確保各方面內(nèi)容受到保護(hù)和修改控制，確保各項(xiàng)工作順利進(jìn)行，特此制定本公司軟件產(chǎn)品命名規(guī)范，凡本公司設(shè)計(jì)開發(fā)的軟件產(chǎn)品及程序均應(yīng)符合本規(guī)范。2. 適用范圍本規(guī)定適用于公司所有軟件產(chǎn)品和每一個(gè)可獨(dú)立維護(hù)并受控的程序。3.

2、名詞定義程序：程序是一系列按照特定順序組織的計(jì)算機(jī)數(shù)據(jù)和指令的集合。一般指源碼的編譯成果，程序的類型包括dll、exe、ocx、jar、war等。軟件產(chǎn)品：軟件產(chǎn)品是程序設(shè)計(jì)的最終結(jié)果，是最終向用戶發(fā)布的軟件。它可以是一個(gè)特定的程序，也可以是一組功能聯(lián)系緊密，可以互相協(xié)作的程序的集合。此外軟件產(chǎn)品還應(yīng)包括與這些程序相關(guān)的文檔。4. 軟件產(chǎn)品標(biāo)識(shí)軟件產(chǎn)品的標(biāo)識(shí)由軟件產(chǎn)品名稱和軟件產(chǎn)品的版本兩部分參數(shù)組成。4.1軟件產(chǎn)品名稱軟件產(chǎn)品一般都有中文名稱、英文名稱及簡(jiǎn)稱三種方式的標(biāo)識(shí)。公司所有軟件產(chǎn)品在立項(xiàng)開發(fā)時(shí)，軟件產(chǎn)品名稱按統(tǒng)一標(biāo)準(zhǔn)命名，標(biāo)準(zhǔn)說明如下：4.1.1軟件產(chǎn)品的中文名稱軟件產(chǎn)品的中文名稱要

3、求能夠體現(xiàn)產(chǎn)品內(nèi)容和產(chǎn)品屬性。4.1.2軟件產(chǎn)品英文名稱軟件產(chǎn)品的英文名稱由三部分組成：公司的標(biāo)識(shí)（）、產(chǎn)品標(biāo)志（目前一般用、等）、中文名稱的英文全稱。除英文縮寫組合外，英文單詞都采用首字母或關(guān)鍵字母大寫的方法。4例如：EHLSmartDataSynchronizesSystem4.1.3軟件產(chǎn)品的簡(jiǎn)稱軟件產(chǎn)品的簡(jiǎn)稱也是由三部分組成：公司的標(biāo)識(shí)、產(chǎn)品標(biāo)志、英文名稱的縮寫（一般為各單詞首字母組合）。例如：EHLSmartDSS4.2軟件產(chǎn)品版本軟件產(chǎn)品的版本直接體現(xiàn)在版本號(hào)的命名上，命名格式有兩種：主版本號(hào).子版本號(hào)或主版本號(hào).子版本號(hào).變更版本號(hào).修正版本號(hào)當(dāng)軟件產(chǎn)品初版時(shí)，變更版本號(hào)和修正版

4、本號(hào)都為0，可以忽略不計(jì)，所以采用第一種方式，只標(biāo)識(shí)主版本號(hào)和子版本號(hào)；主版本號(hào)和子版本號(hào)的修改標(biāo)志這軟件產(chǎn)品的升級(jí)開發(fā)，須提交立項(xiàng)申請(qǐng)，由立項(xiàng)評(píng)審委員會(huì)決定。一般來說，前一位版本號(hào)變動(dòng)時(shí)后一位的版本號(hào)自動(dòng)清零。4.2.1主版本號(hào)1位數(shù)字，當(dāng)功能模塊有較大的變動(dòng)，比如增加多個(gè)模塊或者整體架構(gòu)發(fā)生變化。4.2.2子版本號(hào)1位數(shù)字，當(dāng)功能有一定的增加或變化。4.2.3變更版本號(hào)1-2位數(shù)字，產(chǎn)品的組成程序有所增減變動(dòng)或數(shù)據(jù)庫結(jié)構(gòu)變動(dòng)。此版本號(hào)由項(xiàng)目經(jīng)理決定是否修改。4.2.4修正版本號(hào)1-2位數(shù)字，產(chǎn)品的組成程序有的變更，例如修復(fù)一個(gè)嚴(yán)重的bug即可發(fā)布一個(gè)修訂版。此版本號(hào)由項(xiàng)目經(jīng)理決定是否修改。

5、64.3其他另外，當(dāng)軟件產(chǎn)品用于一些特殊用途時(shí)，還可以在版本號(hào)后面加入其他版本標(biāo)識(shí)：* alpha(a)內(nèi)部測(cè)試版* beta(B)外部測(cè)試版* demo演示版是否需要加入特殊版本標(biāo)識(shí)由質(zhì)量保證部決定。5程序的標(biāo)識(shí)程序的表示也包括程序名稱和版本。5.1程序的版本程序的版本命名格式與軟件產(chǎn)品的命名格式類似：主版本號(hào).子版本號(hào).變更版本號(hào).修正版本號(hào)5.1.1主版本號(hào)及子版本號(hào)各1位數(shù)字，一般來說程序的主版本號(hào)與子版本號(hào)與軟件產(chǎn)品的版本號(hào)相同，但當(dāng)程序?qū)儆诳晒┒鄠€(gè)項(xiàng)目共享的公共程序或其他一些特殊情況時(shí)，可由項(xiàng)目經(jīng)理確定。5.1.2變更版本號(hào)1-2位數(shù)字，當(dāng)數(shù)據(jù)庫內(nèi)部發(fā)生變化或功能有增減變動(dòng)時(shí)，第三

6、段變更版本號(hào)遞增1，前兩段不變，第四段歸零；此版本號(hào)由研發(fā)人員決定是否修改。5.1.3修正版本號(hào)1-2位數(shù)字，當(dāng)軟件進(jìn)行局部修改或BUG修正時(shí)，前三段不變，第四段修正版本號(hào)遞增1；此版本號(hào)由研發(fā)人員決定是否修改。85.2程序的名稱可按照項(xiàng)目組所選擇的命名規(guī)則規(guī)定程序的名稱，程序名稱應(yīng)該具有代表性。命名空間的規(guī)定.net開發(fā)工具開發(fā)的程序，由于文件本身帶有版本屬性，因此無需再在文件名中加入程序版本，按照.net編程的命名空間命名習(xí)慣規(guī)定凡公司開發(fā)的.net程序須遵守下述規(guī)定。.net程序的命名空間一般使用4級(jí)，如確需細(xì)分可使用5級(jí)。例如：Ehl.Atms.Common.ImageConverte

7、r.dll或Ehl.Atms.Common.Net.FtpRequest.dll命名要求如下：Ehl.Atms.GPS.UI組件功能組件所屬類型或所屬業(yè)務(wù)模塊產(chǎn)品領(lǐng)域公司標(biāo)識(shí)產(chǎn)品領(lǐng)域分類Atms：智能交通Ccs:公安與城市應(yīng)急聯(lián)動(dòng)Epa：電子警務(wù)(e_PoliceAffiar)類型或業(yè)務(wù)分類業(yè)務(wù)類型分類一般為業(yè)務(wù)系統(tǒng)的英文首字母縮寫(可參考已發(fā)布的軟件產(chǎn)品名稱)，包括Desktop-桌面平臺(tái)GPS-車輛定位系統(tǒng)UTC-交通控制系統(tǒng)PMS-電子警察TGS-卡口系統(tǒng)Attemper-指揮調(diào)度支術(shù)股份有限公司10CCTV-視頻監(jiān)控DeviceAlarm-設(shè)備報(bào)警DeviceList-設(shè)備列表DLP-

8、大屏控制EMS-接處警GIS-地圖數(shù)據(jù)IID-事件檢測(cè)Plugin-插件管理PPS-預(yù)案管理Task-任務(wù)下發(fā)TFM-流量管理VMS-誘導(dǎo)管理AutoUpdate-自動(dòng)更新其中一些共用的組件命名要求意義明確，包括：Common-公共組件Web-B/S組件Service:服務(wù)組件類型要求使用意義明確的名稱，例如:UI-用戶界面Interface-接口類Factory-反射工廠類Implement-工廠方法實(shí)現(xiàn)類5.2.2JAVA程序的命名由于JAVA程序?qū)С龅奈募粠О姹緲?biāo)識(shí)，因此要求發(fā)布的程序（JAR包和WAR包）文件名包括版本信息，版本標(biāo)識(shí)方法見下節(jié)。Jar程序JAVA歸檔文件，能將許多文件

9、組合成一個(gè)壓縮文件。JAR文件格式基于ZIP文件格11式，不僅用于壓縮和發(fā)布，而且還用于部署、封裝庫、組件和插件程序，可像編譯器和JVM這樣的工具直接使用。JAR文件可以用于發(fā)布和使用類庫，用于打包與組件相關(guān)聯(lián)的輔助資源，作為應(yīng)用程序和擴(kuò)展的構(gòu)建單元，作為組件、applet或者插件程序的部署單位。要求公司自主開發(fā)JAVA程序中JAR包的命名帶有公司標(biāo)識(shí)和版本號(hào)，例如：Ehl_Webgis_.jarEhl_AppFrame_.jar命名要求如下：Ehl_Webgis版本號(hào)所屬業(yè)務(wù)模塊公司標(biāo)識(shí)第三方JAR包可保留原名稱。War程序網(wǎng)絡(luò)應(yīng)用程序文件，是與平臺(tái)

10、無關(guān)的文件格式，它允許將許多文件組合成一個(gè)壓縮文件。為J2EE應(yīng)用程序創(chuàng)建的JAR文件是EAR文件（企業(yè)JAR文件）war專用在web方面。要求JAVA程序發(fā)布的WAR包帶有公司標(biāo)識(shí)、業(yè)務(wù)類型名稱以及版本號(hào)，由于其部署在tomcat下，并作為URL地址一部分的特殊性，為了輸入簡(jiǎn)便，中間不使用特殊字符，例如：EhlTAPA2000.war命名要求如下：EhlTAPA2000.war版本號(hào)業(yè)務(wù)類型公司標(biāo)識(shí)支術(shù)股份有限公司125.2.3其他程序的命名帶版本屬性的程序其他開發(fā)平臺(tái)編寫的程序，如果其程序本身屬性可以帶有版本屬性，則程序名稱應(yīng)帶有公司標(biāo)識(shí)、業(yè)務(wù)類型名稱。例如：EhlVmsCCU.exe無版本屬性的程序其他開發(fā)平臺(tái)編寫的程序，如果其程序本身屬性可以帶有版本屬性，則程序名稱