4软件产品命名规范.doc

作业文件：软件产品版本管理规范 文件编号：Q/EHL-CX08-ZY02-2008文件编号：Q/EHL-CX08-ZY02-2008北京易华录信息技术股份有限公司质量管理体系文件软件产品命名规范Version B/0编写：樊平审核：李艳东批准：李艳东实施日期：2009-2-1受控状态： 受控发放编号：文件会签部门会签人/日期部门会签人/日期智能交通技术研究院李艳东北京易华录信息技术股份有限公司二零零九年修改记录日期版本说明修改人2009-11-9V1.1增加“6.公司名称属性的命名”樊平1.目的为了确保公司各个软件产品及程序的正确性、统一性，确保各方面内容受到保护和修改控制，确保各项工作顺利进行，特此制定本公司软件产品命名规范，凡本公司设计开发的软件产品及程序均应符合本规范。2.适用范围本规定适用于公司所有软件产品和每一个可独立维护并受控的程序。3.名词定义程序：程序是一系列按照特定顺序组织的计算机数据和指令的集合。一般指源码的编译成果，程序的类型包括dll、exe、ocx、jar、war等。软件产品：软件产品是程序设计的最终结果，是最终向用户发布的软件。它可以是一个特定的程序，也可以是一组功能联系紧密，可以互相协作的程序的集合。此外软件产品还应包括与这些程序相关的文档。4.软件产品标识软件产品的标识由软件产品名称和软件产品的版本两部分参数组成。4.1软件产品名称软件产品一般都有中文名称、英文名称及简称三种方式的标识。公司所有软件产品在立项开发时，软件产品名称按统一标准命名，标准说明如下：4.1.1软件产品的中文名称软件产品的中文名称要求能够体现产品内容和产品属性。4.1.2软件产品英文名称软件产品的英文名称由三部分组成：公司的标识（EHL）、产品标志（目前一般用Smart、ATMS等）、中文名称的英文全称。除英文缩写组合外，英文单词都采用首字母或关键字母大写的方法。例如：EHL Smart Data Synchronizes System4.1.3软件产品的简称软件产品的简称也是由三部分组成：公司的标识、产品标志、英文名称的缩写（一般为各单词首字母组合）。例如：EHL Smart DSS4.2软件产品版本软件产品的版本直接体现在版本号的命名上，命名格式有两种：主版本号 . 子版本号 或 主版本号 . 子版本号 . 变更版本号 . 修正版本号当软件产品初版时，变更版本号和修正版本号都为0，可以忽略不计，所以采用第一种方式，只标识主版本号和子版本号；主版本号和子版本号的修改标志这软件产品的升级开发，须提交立项申请，由立项评审委员会决定。一般来说，前一位版本号变动时后一位的版本号自动清零。4.2.1主版本号1位数字，当功能模块有较大的变动，比如增加多个模块或者整体架构发生变化。4.2.2子版本号1位数字，当功能有一定的增加或变化。4.2.3变更版本号1-2位数字，产品的组成程序有所增减变动或数据库结构变动。此版本号由项目经理决定是否修改。4.2.4修正版本号1-2位数字，产品的组成程序有的变更，例如修复一个严重的bug即可发布一个修订版。此版本号由项目经理决定是否修改。4.3其他另外，当软件产品用于一些特殊用途时，还可以在版本号后面加入其他版本标识：*alpha（）内部测试版*beta（）外部测试版 *demo演示版 是否需要加入特殊版本标识由质量保证部决定。5程序的标识程序的表示也包括程序名称和版本。5.1程序的版本程序的版本命名格式与软件产品的命名格式类似： 主版本号 . 子版本号 . 变更版本号 . 修正版本号5.1.1主版本号及子版本号各1位数字，一般来说程序的主版本号与子版本号与软件产品的版本号相同，但当程序属于可供多个项目共享的公共程序或其他一些特殊情况时，可由项目经理确定。5.1.2变更版本号1-2位数字，当数据库内部发生变化或功能有增减变动时，第三段变更版本号递增1，前两段不变，第四段归零；此版本号由研发人员决定是否修改。5.1.3修正版本号1-2位数字，当软件进行局部修改或BUG修正时，前三段不变，第四段修正版本号递增1；此版本号由研发人员决定是否修改。5.2程序的名称可按照项目组所选择的命名规则规定程序的名称，程序名称应该具有代表性。5.2.1 .net命名空间的规定.net开发工具开发的程序，由于文件本身带有版本属性，因此无需再在文件名中加入程序版本，按照.net编程的命名空间命名习惯规定凡公司开发的.net程序须遵守下述规定。.net程序的命名空间一般使用4级，如确需细分可使用5级。例如：Ehl.Atms.Common.ImageConverter.dll或Ehl.Atms.Common.Net.FtpRequest.dll命名要求如下：Ehl.Atms.GPS.UI 组件功能 组件所属类型或所属业务模块 产品领域 公司标识产品领域分类Atms：智能交通Ccs：公安与城市应急联动Epa：电子警务（e_Police Affiar）类型或业务分类业务类型分类一般为业务系统的英文首字母缩写（可参考已发布的软件产品名称），包括：Desktop-桌面平台GPS-车辆定位系统UTC-交通控制系统PMS-电子警察TGS-卡口系统Attemper-指挥调度CCTV-视频监控DeviceAlarm-设备报警DeviceList-设备列表DLP-大屏控制EMS-接处警GIS-地图数据IID-事件检测Plugin-插件管理PPS-预案管理Task-任务下发TFM-流量管理VMS-诱导管理AutoUpdate-自动更新其中一些共用的组件命名要求意义明确，包括：Common-公共组件Web-B/S组件Service：服务组件类型要求使用意义明确的名称，例如：UI-用户界面Interface-接口类Factory-反射工厂类Implement-工厂方法实现类5.2.2 JAVA程序的命名由于JAVA程序导出的文件不带版本标识，因此要求发布的程序（JAR包和WAR包）文件名包括版本信息，版本标识方法见下节。Jar程序JAVA归档文件，能将许多文件组合成一个压缩文件。JAR 文件格式基于ZIP 文件格式，不仅用于压缩和发布，而且还用于部署、封装库、组件和插件程序，可像编译器和 JVM 这样的工具直接使用。JAR文件可以用于发布和使用类库 ，用于打包与组件相关联的辅助资源，作为应用程序和扩展的构建单元，作为组件、applet 或者插件程序的部署单位。要求公司自主开发JAVA程序中JAR包的命名带有公司标识和版本号，例如：Ehl_Webgis_1.0.0. 0.jarEhl_AppFrame_.jar命名要求如下： Ehl_Webgis 版本号 所属业务模块 公司标识第三方JAR包可保留原名称。War程序 网络应用程序文件，是与平台无关的文件格式，它允许将许多文件组合成一个压缩文件。为 J2EE 应用程序创建的 JAR 文件是 EAR 文件（企业 JAR 文件）war专用在web方面 。要求JAVA程序发布的WAR包带有公司标识、业务类型名称以及版本号，由于其部署在tomcat下，并作为URL地址一部分的特殊性，为了输入简便，中间不使用特殊字符，例如：EhlTAPA2000.war 命名要求如下： EhlTAPA2000.war 版本号 业务类型 公司标识5.2.3其他程序的命名带版本属性的程序其他开发平台编写的程序，如果其程序本身属性可以带有版本属性，则程序名称应带有公司标识、业务类型名称。例如：EhlVmsCCU.exe无版本属性的程序其他开发平台编写的程序，如果其程序本身属性可以带有版本属性，则程序名称应带有公司标识、业