软件项目代码编码规范

日期：2020年 月 日 1

变更履历

版本 1.0

文件内容描述 正式发布 编写日期 2020年 月 日 编写 审批 2

目录

1 2 3 4

总则 ........................................................................................................................................... 1 源代码完整性保障 .................................................................................................................... 1 源代码的授权访问 .................................................................................................................... 1 代码版本管理 ............................................................................................................................ 2 4.1 4.2 4.3 4.4

系统初验 ................................................................................................................................. 3 试运行 ..................................................................................................................................... 3 系统终验 ................................................................................................................................. 4 系统验收标准 ......................................................................................................................... 4

3

1 总则

1、为保障公司源代码和开发文档安全不至于泄露，保证源代码的完整，明确源代码控制管理流程，特制定此管理办法。

2、本办法适用于所有涉及接触源代码的各部门各岗位。所涉及部门都必须严格执行本管理办法。

3、源代码直接控制管理部门为技术开发部。

4、本办法管理重点在于控制管理源代码的完整性，不被非授权获取，不被非授权复制和传播。

5、本办法所指源代码不仅限于公司开发人员自行编写实现功能的程序代码，而且还包括相应的开发设计文档及用于支撑整个系统运行所必须具备的第三方软件、控件和其它支撑库等文件。

2 源代码完整性保障

1、所有软件的源代码文件及相应的开发设计文档均必须及时加入到指定的源代码服务器中的指定库中。

2、我们研发的产品软件运行所必须的第三方软件、控件和其它支撑库等文件也必须及时加入源代码服务器中指定的库中。

3、软件开始编写或者调整代码之前，其相应的设计文档和代码必须先从相应的SVN库进行SVNUpdate操作。软件编码或功能调整结束测试正确无误后，相应的源代码必须进行SVNCommit操作，在最终进行SVNCommit操作之前需要再进行SVNUpdate操作，查看是否有冲突产生，如果有冲突产生需要和冲突相关人一并解决冲突。

3 源代码的授权访问

1、源代码服务器对于共享的SVN库的访问建立操作系统级的，基于身份和口令的访问授权。

第十条 在SVN库中设置用户，并为不同用户分配不同的，适合工作的最小

1

访问权限。要求连接SVN库时必须校验SVN中用户身份及其口令。在SVN库中要求区别对待不同用户的可访问权、可读权、可写权。

2、曾经涉及、触及源代码的计算机在转作它用，或者离开研发部门之前必须由网络管理人员全面清除计算机硬盘中存储的源代码。如果不能确定，必须对计算机中所有硬盘进行全面格式化后方可以转做它用或离开研发部门。

4 代码版本管理

1、终端软件的版本标识管理

终端软件版本由终端型号、版本号和内部修订号来进行标识。 终端型号：终端型号是硬件标识号，也唯一的标识了我们的项目。 版本号：由“＜主版本号＞.＜次版本号＞.＜修订号＞”三段组成，中间是点号分开。版本号的目的主要是管理终端软件的对外发布，终端软件的ＢＵＧ的记录和统计，主要是针对于版本号的，测试部、项目部、客户等会记录某个版本号的终端软件存在哪些ＢＵＧ，ＢＵＧ会在哪个版本号中得到修正；终端软件一个新的版本号出来后，我们会统计新的版本号解决了上一个版本号中的哪些ＢＵＧ，以及增加了哪些新功能，等等。

内部修订号：也就是“应用程序的源代码的svn修订号”，主要是由软件部和测试部内部来使用，内部修订号唯一标识我们的终端软件，即：通过内部修订号能够唯一的找出我们发布的终端软件所对应的全部软件源代码，目的是为了软件排错使用。

另外，终端软件在发布时，还会给出发布日期，以便开发、测试、项目、客户等相关人员参考。 2、终端软件版本发布管理

终端软件主要是以版本号为基准，对外发布，目前采用不定时发布策略，发布的时间由软件部、项目部和客户方根据情况，共同商量决定。

由于目前项目时间紧，终端软件无法得到完整的测试就要发布，在发布之后，有一些需要紧急需要修复的BUG，软件部需要紧急修复后就要发布更新包，以便用户能够使用，所以，在一个版本号发布后，需要进行多次修订，对于这些修订的版本，其版本号保持不变，内部修订发生变化。

软件ＢＵＧ记录、管理和统计

2

软件ＢＵＧ的记录、管理和统计主要以版本号为基准，但为了软件开发人员能够找到ＢＵＧ的出处，需要用户、测试人员在报告和验证ＢＵＧ时，输入内部修订号。

3、软件配置组对版本的记录

软件版本记录的目标有两个： 记录软件版本的发布历史；

发布的每一个版本，都要能够唯一的从源代码库（ＳＶＮ）中找到对应的全部源代码。

测试方案：作为软件开发的重要环节，作为交付成功的优质的产品的重要保证手段和方法，软件测试越来越受到项目的重视。要做好测试首先要做好测试的组织、管理、计设、实施等工作。

系统测试方案概述：测试是指在软件投入运行前，对软件需求分析、设计规格说明和编码的最终复审，是软件质量保证的关键步骤。

测试的目标：以较少的用例、时间和人力找出软件中潜在的各种错误和缺陷，以确保系统的质量。

在实际项目中，测试作为软件开发生命周期中的一个重要过程，但从其具体工作的前后过程来看，它又是由一系列的不同测试所组成，这些测试的步骤分为：单元测试、集成测试（又称组装测试）、确认测试和系统测试。软件开发的过程是自顶向下的，测试则正好相反，以上这些过程就是自底向上，逐步集成的。在项目过程中，我们按以上的测试步骤完成系统的测试。

严格执行代码管理流程。对于开发完成的系统进行测试发布。 4.1 系统初验

系统初验由技术开发部进行单项测试，系统进行联调测试无误后，由开发部编制项目测试报告，提交测试报告给汇测试部审核，完成系统初验。 4.2 试运行

本系统集成后上线运行三个月为试运行期。

由公司技术人员现场排除系统试运行过程中出现的硬件故障及软件故障，对于易出现问题的设备提供备用件。技术人员随时解答业务人员在使用过程中出现的问题并进行解决。

3

4.3 系统终验

正式验收主要围绕设备的配置、功能、性能及各项技术参数指标进行，完成用户整体的系统验收。

当整个系统进入试运行期，技术开发部提供行之有效的技术支持以确保整个业务的稳定和有效地运营，并确保整个业务能够顺利通过系统验收。在此同时，技术开发部将通过具体的技术支持帮助汇运维操作人员熟悉和掌握这些设备和维护技术。

系统试运行期是一个非常重要的时期。在此期间，由于运维技术人员的技术水平、设备管理、设备操作和具体设备维护之间的磨合，将会出现许多意想不到的问题和人为故障。因此在系统试运行期，技术开发人员需配合运维人员提出的要求提供必要的现场技术支持，同时通过定期维护以避免设备故障的发生。

在通过系统试运行的情况下，技术开发的项目小组将和业务运营人员以及运维人员进行系统终验。 4.4 系统验收标准

项目的验收工作包括两个方面的活动：文档评审和软件产品包的测试与试运行检验，对于不同的验收活动制定不同的验收通过标准。

4