变更履历
目录
1总则 (4)
2源代码完整性保障 (4)
3源代码的授权访问 (4)
4代码版本管理 (5)
4.1系统初验 (6)
4.2试运行 (6)
4.3系统终验 (7)
4.4系统验收标准 (7)
1总则
1、为保障公司源代码和开发文档安全不至于泄露，保证源代码的完整，明确源代码控制管理流程，特制定此管理办法。
2、本办法适用于所有涉及接触源代码的各部门各岗位。所涉及部门都必须严格执行本管理办法。
3、源代码直接控制管理部门为技术开发部。
4、本办法管理重点在于控制管理源代码的完整性，不被非授权获取，不被非授权复制和传播。
5、本办法所指源代码不仅限于公司开发人员自行编写实现功能的程序代码，而且还包括相应的开发设计文档及用于支撑整个系统运行所必须具备的第三方软件、控件和其它支撑库等文件。
2源代码完整性保障
1、所有软件的源代码文件及相应的开发设计文档均必须及时加入到指定的源代码服务器中的指定库中。
2、我们研发的产品软件运行所必须的第三方软件、控件和其它支撑库等文件也必须及时加入源代码服务器中指定的库中。
3、软件开始编写或者调整代码之前，其相应的设计文档和代码必须先从相应的SVN库进行SVNUpdate操作。软件编码或功能调整结束测试正确无误后，相应的源代码必须进行SVNCommit操作，在最终进行SVNCommit操作之前需要再进行SVNUpdate操作，查看是否有冲突产生，如果有冲突产生需要和冲突相关人一并解决冲突。
3源代码的授权访问
1、源代码服务器对于共享的SVN库的访问建立操作系统级的，基于身份和口令的访问授权。
第十条在SVN库中设置用户，并为不同用户分配不同的，适合工作的最小
访问权限。要求连接SVN库时必须校验SVN中用户身份及其口令。在SVN库中要求区别对待不同用户的可访问权、可读权、可写权。
2、曾经涉及、触及源代码的计算机在转作它用，或者离开研发部门之前必须由网络管理人员全面清除计算机硬盘中存储的源代码。如果不能确定，必须对计算机中所有硬盘进行全面格式化后方可以转做它用或离开研发部门。
4代码版本管理
1、终端软件的版本标识管理
终端软件版本由终端型号、版本号和内部修订号来进行标识。
终端型号：终端型号是硬件标识号，也唯一的标识了我们的项目。
版本号：由“＜主版本号＞.＜次版本号＞.＜修订号＞”三段组成，中间是点号分开。版本号的目的主要是管理终端软件的对外发布，终端软件的ＢＵＧ的记录和统计，主要是针对于版本号的，测试部、项目部、客户等会记录某个版本号的终端软件存在哪些ＢＵＧ，ＢＵＧ会在哪个版本号中得到修正；终端软件一个新的版本号出来后，我们会统计新的版本号解决了上一个版本号中的哪些ＢＵＧ，以及增加了哪些新功能，等等。
内部修订号：也就是“应用程序的源代码的svn修订号”，主要是由软件部和测试部内部来使用，内部修订号唯一标识我们的终端软件，即：通过内部修订号能够唯一的找出我们发布的终端软件所对应的全部软件源代码，目的是为了软件排错使用。
另外，终端软件在发布时，还会给出发布日期，以便开发、测试、项目、客户等相关人员参考。
2、终端软件版本发布管理
终端软件主要是以版本号为基准，对外发布，目前采用不定时发布策略，发布的时间由软件部、项目部和客户方根据情况，共同商量决定。
由于目前项目时间紧，终端软件无法得到完整的测试就要发布，在发布之后，有一些需要紧急需要修复的BUG，软件部需要紧急修复后就要发布更新包，以便用户能够使用，所以，在一个版本号发布后，需要进行多次修订，对于这些修订的版本，其版本号保持不变，内部修订发生变化。
软件ＢＵＧ记录、管理和统计
软件ＢＵＧ的记录、管理和统计主要以版本号为基准，但为了软件开发人员能够找到ＢＵＧ的出处，需要用户、测试人员在报告和验证ＢＵＧ时，输入内部修订号。
3、软件配置组对版本的记录
软件版本记录的目标有两个：
记录软件版本的发布历史；
发布的每一个版本，都要能够唯一的从源代码库（ＳＶＮ）中找到对应的全部源代码。
测试方案：作为软件开发的重要环节，作为交付成功的优质的产品的重要保证手段和方法，软件测试越来越受到项目的重视。要做好测试首先要做好测试的组织、管理、计设、实施等工作。
系统测试方案概述：测试是指在软件投入运行前，对软件需求分析、设计规格说明和编码的最终复审，是软件质量保证的关键步骤。
测试的目标：以较少的用例、时间和人力找出软件中潜在的各种错误和缺陷，以确保系统的质量。
在实际项目中，测试作为软件开发生命周期中的一个重要过程，但从其具体工作的前后过程来看，它又是由一系列的不同测试所组成，这些测试的步骤分为：单元测试、集成测试（又称组装测试）、确认测试和系统测试。软件开发的过程是自顶向下的，测试则正好相反，以上这些过程就是自底向上，逐步集成的。在项目过程中，我们按以上的测试步骤完成系统的测试。
严格执行代码管理流程。对于开发完成的系统进行测试发布。
4.1系统初验
系统初验由技术开发部进行单项测试，系统进行联调测试无误后，由开发部编制项目测试报告，提交测试报告给汇测试部审核，完成系统初验。
4.2试运行
本系统集成后上线运行三个月为试运行期。
由公司技术人员现场排除系统试运行过程中出现的硬件故障及软件故障，对于易出现问题的设备提供备用件。技术人员随时解答业务人员在使用过程中出现的问题并进行解决。
4.3系统终验
正式验收主要围绕设备的配置、功能、性能及各项技术参数指标进行，完成用户整体的系统验收。
当整个系统进入试运行期，技术开发部提供行之有效的技术支持以确保整个业务的稳定和有效地运营，并确保整个业务能够顺利通过系统验收。在此同时，技术开发部将通过具体的技术支持帮助汇运维操作人员熟悉和掌握这些设备和维护技术。
系统试运行期是一个非常重要的时期。在此期间，由于运维技术人员的技术水平、设备管理、设备操作和具体设备维护之间的磨合，将会出现许多意想不到的问题和人为故障。因此在系统试运行期，技术开发人员需配合运维人员提出的要求提供必要的现场技术支持，同时通过定期维护以避免设备故障的发生。
在通过系统试运行的情况下，技术开发的项目小组将和业务运营人员以及运维人员进行系统终验。
4.4系统验收标准
项目的验收工作包括两个方面的活动：文档评审和软件产品包的测试与试运行检验，对于不同的验收活动制定不同的验收通过标准。
软件项目的编码 一、编码文档 编码阶段的产品是按照代码标准和规范编写的代码，必要的时候进行部署。编码提交的文档包括代码标准规范和源代码。 二、项目案例 项目案例名称：综合信息管理平台 项目案例文档：《综合信息管理平台编码规范及其代码说明》 1、导言 1.1 目的 该文档的目的是描述综合信息管理平台的编码规范和对代码的说明，其主要内容包括编码规范，命名规范，注释规范，语句规范，声明规范，目录设置，代码说明。 本文档的预期读者是开发人员，项目管理人员，质量保证人员。 1.2 范围 该文档定义了本项目的代码编写规范，以及部分代码描述和相关代码的说明。 1.3 术语定义 Class（类）：Java程序中的一个程序单位，可以生成很多实例。 Packages（包）：由很多类组成的工作包。 1.4 引用标准 （1）企业文档格式标准V1.1，北京长江软件有限公司。 （2） 1.5 参考资料 （1） 1.6 版本更新信息 本文档版本更新记录如表X-XXX所示。 表X-XXX 版本更新记录 2、编码书写格式规范 严格要求编码书写格式是为了使程序整齐美观，易于阅读，风格统一，程序员对规范书写的必要性要有明确的认识。建议程序使用Eclipse工具开发，格式规范预先在工具中设置。 2.1 缩进排版 4个空格作为一个缩进排版单位。 2.2 行长度 尽量避免一行的长度超过80个实际字符，用于文档中的例子应该使用更短和行长，长度一般不超过70个字符。 2.3 断行规则 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开： （1）在一个逗号后面断开。
（2）在一个操作符前面断开。 （3）尽量选择较高运算级别处断开，而非较低运算级别处断开。 （4）如果是以上规则导致代码混乱或者使代码都堆挤在右边，那就代之以缩进8个空格。 2.4空行 空行将逻辑相关的代码段分隔开，以提高可读性。下列情况应该总是使用两个空行：（1）一个源文件的两个片段（section）之间。 （2）类声明和接口声明之间。 下列情况应该总是使用一个空行： （1）两个方法之间。 （2）方法内的局部变量和方法的第一条语句之间。 （3）块注释或单行注释之间。 （4）一个方法内的两个逻辑段之间。 3、命名规范 命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码。 3.1 包（Package） 一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名，通常是com、edu、gov、mil、net、org，或1981年ISO3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门（department）、项目（project）、机器（machine）或注册名（login names）。如：com.sun.eng 3.2 类（Class） 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。尽量使用类名简洁而富于描述性。使用完整单词，避免缩写词（除非该缩写词被更广泛使用，像URL、HTML）。 3.3 接口（Interface） 大小写规则与类名相似。 3.4 方法（Method） 方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。 3.5 变量（Variable） 采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。变量名不应该以下划线或美元符号开头，尽管这在语法上是允许的。变量名应该易于记忆，且能够指出其用途。尽量避免单个字符的变量名，除非是一次性临时变量。 3.6 实例变量（Instance Variable） 大小写规则和变量名相似，除了前面需要一个下划线。 3.7 常量（Constant） 类常量和ANSI常量的声明，应该全部大写，单词间用下划线隔开。 4、声明规范 程序中定义的数据类型，在计算机中都要为其开辟一定数量的存储单元，为了不造成资源的不必要的浪费，所以按需定义数据的类型，声明包、类以及接口。 4.1 每行声明变量的数量 推荐一行一个声明，因为这样有利于写注释。不要将不同类型变量的声明放在同一行！ 4.2 初始化
软件系统JAVA 编码规范 版本V1.0
文档信息： 内容范围： 本文档是软件系统JAVA编码规范。适用的对象： 公司相关技术人员。
目录 1 介绍（INTRODUCTION） (5) 2 2 文件名（FILE NAMES） (6) 2.1文件后缀（F ILE S UFFIXES） (6) 2.2常用文件名（C OMMON F ILE N AMES） (6) 3 文件组织（FILE ORGANIZATION） (7) 3.1J AVA源文件（J AVA S OURCE F ILES） (7) 3.1.1开首注释（B EGINNING C OMMENTS） (7) 3.1.2包和引入语句（P ACKAGE AND I MPORT S TATEMENTS） (8) 3.1.3类和接口声明（C LASS AND I NTERFACE D ECLARATIONS） (8) 4 缩进排版（INDENTATION） (9) 4.1行长度（L INE L ENGTH） (9) 4.2换行（W RAPPING L INES） (9) 5 注释（COMMENTS） (13) 5.1实现注释的格局（I MPLEMENTATION C OMMENT F ORMATS） (13) 5.1.1块注释（B LOCK C OMMENTS） (13) 5.1.2单行注释（S INGLE-L INE C OMMENTS） (14) 5.1.3尾端注释（T RAILING C OMMENTS） (15) 5.1.4行末注释（E ND-O F-L INE C OMMENTS） (15) 5.2文档注释（D OCUMENTATION C OMMENTS） (16) 6 声明（DECLARATIONS） (17) 6.1每行声明变量的数量（N UMBER P ER L INE） (17) 6.2初始化（I NITIALIZATION） (17) 6.3布局（P LACEMENT） (17) 6.4类和接口的声明（C LASS AND I NTERFACE D ECLARATIONS） (18) 7 语句（STATEMENTS） (20) 7.1简单语句（S IMPLE S TATEMENTS） (20) 7.2复合语句（C OMPOUND S TATEMENTS） (20)
项目代码编程规范 1.应用范围 本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP，SERVLET，JAVABEAN，EJB）JS代码、HTML代码及数据库设计均应遵守这个规范。同时，也可作为其它项目的参考。 2.设计类和方法 2.1. 创建具有很强内聚力的类 方法的重要性往往比类的重要性更容易理解，方法是指执行一个独立逻辑的一段代码。类常被错误的视为是一个仅仅用于存放方法的容器。有些开发人员甚至把这种思路作了进一步的发挥，将他们的所有方法放入单个类之中。 之所以不能正确的认识类的功能，原因之一是类的实现实际上并不影响程序的执行。当一个工程被编译时，如果所有方法都放在单个类中或者放在几十个类中，这没有任何关系。虽然类的数量对代码的执行并无太大的影响，但是当创建便于调试和维护的代码时，类的数量有时会带来很大的影响。 类应该用来将相关的方法组织在一起。 当类包含一组紧密关联的方法时，该类可以说具有强大的内聚力。当类包含许多互不相关的方法时，该类便具有较弱的内聚力。应该努力创建内聚力比较强的类。 大多数工程都包含许多并不十分适合与其他方法组合在一起的方法。在这种情况下，可以为这些不合群的方法创建一个综合性收容类。 创建类时，应知道“模块化”这个术语的含义是什么。类的基本目的是创建相当独立的程序单元。 2.2. 创建松散连接和高度专用的方法 2.2.1.使所有方法都执行专门的任务 每个方法都应执行一项特定的任务，它应出色的完成这项任务。应避免创建执行许多不同任务的方法。 创建专用方法有许多好处。首先调试将变得更加容易。 2.2.2.尽量使方法成为自成一体的独立方法 当一个方法依赖于其他方法的调用时，称为与其他方法紧密连接的方法。紧密连接的方法
项目开发规范文档修订历史记录
1.简介 目的 1、用于规范指导开发组进行开发 2、便于成员间的沟通与交流。 3、有助于项目质量和稳定。 4、为后期维护提供支持 2. 项目开发流程 项目开发过程归纳分为以下步骤： 1. 建立SVN项目版本控制。包括文档，源码，Lib包等。 2. 了解需求，并对需求文档的书写。(见文档结构规则附录)。 3. 详细设计文档。(见文档结构规则附录)。 功能模块设计，重要模块的算法设计。 数据库设计等。 根据需求定义开发平台及环境。 4. 编码。 搭建开发平台，配置开发环境。 编码。 单元测试案例。 5. 书写软件安装手册文件，数据库脚本文件，以及注意事项(release notes)。 6. 交互测试组测试。根据测试组测试结果是否回归第4步（测试回归最好不要超过2 次）。 7. 测试通过，交付上线使用。 维护手册 使用手册
3. 代码规范 Java 代码规范 3.1.1 Java类名 类名可由：英文字母，数字，下划线组成。（数字，下划线不能够开头） 类名由一个或者多个单词组成。单词通常要求简洁明了达意。能够通过类名能够大致了解此类的作用和用途。 类名要求首字母大写，多个单词组成类名时，单词的首字母要求大写。 建议：类名不要过于简单或者太长。可以对单词采用简化的名称：入： Number 简化为：num 。 3.1.2 Java类结构 类仅作为数据结构，没有行为，他封装了一组或者相似的一些行为方法。所以一个类尽量功能单一，或者功能类似共有行为的。一个类不要过于庞大。 通常情况下： 一般逻辑类中应该有构造方法和main方法，main方法中应该有测试代码。 每个类应该有 toString() 方法。 3.1.2.1 包和引入语句 在多数Java源文件中，第一个非注释行是包语句。在它之后可以跟引入语句。 报名的定义全部是小写字母。具体定义依据项目而定。 引入包时候，同一类型的归纳到一块，用空行隔开。例如： import 3.1.2 类注释 Java类开头应该有相应的注释：类版本描述，作者签名，日期时间，公司备注，类的功能作用相关描述等。（详细查看：注释） 3.1.2.2 类成员变量 a) 类变量要求放在类的开始声明。一行声明一个。 b) 变量名称首字母要求小写。其他命名规则类似与类名。 c) static , final 类型的变量，字母要求全部大写。 d) 尽量在声明局部变量的同时初始化。 e) 避免局部变量和成员变量同名，覆盖了成员变量。 f) 尽量变量私有化，缩小变量的作用域。 3.1.2.3 类成员方法 a) 方法名命名规则类似于成员变量命名规则。 b) 成员方法尽量私有化。
软件开发规范 1 排版 11-1：程序块要采用缩进风格编写，缩进的空格数为4个。 说明：对于由开发工具自动生成的代码可以有不一致。 11-2：相对独立的程序块之间、变量说明之后必须加空行。 示例：如下例子不符合规范。 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 应如下书写 if (!valid_ni(ni)) { ... epssn_index; repssn_ni = ssn_data[index].ni; 11-3：较长的语句（>80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。 示例： = NO7_TO_STAT_PERM_COUNT_LEN + STAT_SIZE_PER_FRAM * sizeof( _UL ); act_task_table[frame_id * STAT_TASK_CHECK_NUMBER + index].occupied
= stat_poi[index].occupied; act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item ); report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER) && (n7stat_stat_item_valid (stat_item)) && (act_task_table[taskno].result_data != 0));
中船重工船业有限公司工程项目编码规则及管理办法 1. 范围 本办法规定公司各种工程编码分类和编码实施规则及其管理办法。 本规则适用于公司内部所有工程项目的编码计划编制、领发料、财务核算、计算机信息处理等。 2. 工程编码类别及其编制规则说明 2.1工程编码类别分为船舶产品工程、非船产品工程、基建工程、自营工程、设备大修、设备维修、设备技改、安全设施及其它工程。 2.2产品工程编码的编制方法 2.2.1 大吨位运输船舶（千吨位以上）工程号的编制方法 2.2.1.1 编码共6 位。前两位为船舶产品载重吨位或承载体积前两位数；第三位为同载重吨位船舶型号，无型号用0 表示，有型号时分为Ⅰ型、Ⅱ型、Ⅲ型等，分别用1、2、3表示，以此类推；第四、五、六位为公司大吨位运输船舶接单顺序号。 2.2.1.2 图示
例如：公司接单第31 艘70000 吨散货船工程编码为：700031 。 公司接单第18 艘33000 吨散货Ⅰ型船工程编码为：331018 。 2.2.2 商务船工程号的编制办法 2.2.2.1 编码共6位。前两位统一名称为SW（商务）；第三、四两位为商务船的长度，五、六两位为商务船接单顺序号。 2.2.2.2 图示 例如：公司接单第1 艘35 米长的商务船，工程号为：SW3501 2.2.3 小吨位（百吨位）运输船工程号的编制办法 2.2. 3.1 编码共6 位。前两位统一名称为YS（运输）；第三、四两位为运输船的吨位前两位，五、六两位为公司小吨位运输船接单顺序号。 2.2. 3.2 图示 例如：公司接单第1 艘载重吨为20 吨的运输船，工程号：YS2001
软件开发工作规范章程 Document serial number【KK89K-LLS98YT-SS8CB-SSUT-SST108】
软件开发工作规范章程 编写目的 本文档是开发团队的日常工作规范，主要侧重开发工作流程的控制，明确软件工程的各阶段开发团队应完成的工作。开发技术和策略等问题不在本文档描述范围内。开发团队构成 1.1职责 肩负着如下责任： 负责开发项目的系统分析、研发与组织实施。 负责开发符合要求的软件。 制定软件开发规范。 协助相关应用软件的安装调试工作。 1.2角色划分 在人力资源有限的情况下，一个团队成员可能会同时承担多个角色。 角色名称相关主要责任 开发组长负责研发团队建设 负责研发项目的工作分工、实施、监控及后续完善工作 参与确定研发产品的种类，并制定研发产品的相关标准及研发工作计划 负责技术路线与方向 完成研发过程中的其他任务 超出能力权限向上一级汇报 根据项目情况，向所属组制定技能提升计划并实施 特性负责人负责研发特性的工作分工、实施、监控及后续完善工作 制定特性的软件开发技术规范及研发工作计划
负责《详细设计》的编写。 按期、按预算交付高质量的产品 建设有凝聚力团队环境，并促使高效的团队协作 负责软件实施规范执行 根据开发规范实施开发工作 软件的程序设计、代码编写与单元测试。 协助《详细设计》的编写。 承担开发任务，按计划完成任务目标。 配合系统分析人员完成软件系统以及模块的需求调 研、需求分析。 协助测试人员完成软件系统及模块的测试。 1.3需求澄清 1.4编码阶段 1.4.1开发规范
1.4.2开发环境准备 1.4.3详细设计 1.4.4编码
工程项目编码体系 ——美国的工程项目编码体系 【摘要】工程项目编码体系作为建设项目的项目管理、成本分析和数据积累的基础，是很重要的业务标准，本文主要介绍美国的工程项目编码体系，为国内建设相应的编码体系提供参考。 【关键词】工程编码项目管理 前言 目前，世界上很多发达国家，如美国、英国、欧洲、加拿大、新加坡等都建立了本国建筑业需要的统一的建设工程项目编码体系，编码在工程管理中的应用，对建筑业发展起到了极大的促进作用。 在使用编码实践方面，美国走在其他国家的前列，它建立了UniformatⅡ和Masterformat等一些比较完善的工程项目编码体系。UniformatⅡ应用于建筑工程总前期策划、图纸设计、建筑施工到建筑物拆除等的全过程，它的编码结构已经发展到四个层次；Masterformat用于已有详细设计图纸的项目，在工程造价控制等方面，它与前者交叉使用，实践证明，取得了良好的效果。此外，美国建设管理部门还鼓励建筑行业不同的专业领域机构或公司建立和使用自己的编码体系。英国建立了RICK-UK和SMM7工程项目编码体系,在英联邦体制下的上百个国家广泛接受和使用；欧盟成立后，由CEEC编写了统一编码,以利于其内部国家建筑业的交流和合作…… 建立编码体系的目的在于对建设项目全过程进行科学有效的管理，规范工程参与者的行为。具体而言，它有利于项目建设单位对项目各个阶段工作内容的控制，如有助于对工程总造价进行管理控制、有助于实行价值工程研究、为项目各成员提供信息交流工具，尤其是为建设单位、设计单位、施工单位之间信息沟通提供一种共同语言，在有效传达信息的同时，消除误解、另外，工程编码为工程项目数据收集和整理提供了标准化手段，为未来项目使用准确的，有价值的信息提供了保证。 国内情况扫描 严格意义上说，我国目前还没有一套独立存在的适合建筑工程各方面使用的统一编码体系，对于地产企业因为成本管理信息化的发展，建立企业内部统一的成本科目已经树立了一些标杆企业，但建筑行业缺乏统一的工程编码。由于没有统一的工程编码，建筑项目各阶段的投资和费用划分及管控、数据积累等处于混乱状态，给有关各参与方在理解和沟通上形成了很大障碍。 编码体系建立 建立工程编码体系必须要符合本国建筑业实际情况，其编码体系能够符合、加强或规范建筑管理的要求，不同国家建立编码体系没有统一的标准，总的原则是要符合本国建筑业管理和发展要求，所以创建者要对本国的建筑业做长期调查和实践，并且编码体系要随着建筑业领域的施工技术、建筑材料、管理方法和建筑理论知识等的发展不断完善。 尽管各国国情不一，但建筑工程项目的管理方法、采用施工技术手段，建筑材料等都是共通的，通过了解美国工程编码体系的建立，为建立我国的工程编码体系提供建议和参考。 一、美国编码体系的背景 美国建筑标准协会(CSI)和加拿大建筑标准学会(CSC)发布过两套编码系统，分别是标准格式(M aster Format)和部位单价格式(Uniformat)，这两套系统应用于几乎所有的建筑物工程和一般的承包工程。其中M 体系是基于产品分类标准；U体系是基于元素分类标准。 国通用事业管理局（General Services Administration简称为GSA）也按照建筑组成元素开发工程建筑行业需要一个建筑信息分类框架，以便在建筑物生命周期的各个阶段包括立项阶段、规划阶段、设计阶段、建造阶段、运维阶段和处置阶段，为建设项目的描述、成本分析、项目管理等提供一个一致的参考。建筑元素分类标准体系UNIFORMAT II满足这些目的。元素是重要的组成部分，对很多建筑物都有共
软件开发代码规范（C） (仅通普信息技术股份有限公司供内部使用) 拟制：杨超日期：2015-3-10审核：夏峰日期：2015-3-10核准：冯敬刚日期：2015-3-17签发：韩殿成日期：2015-3-21文档版本：V1.11 黑龙江通普信息技术股份有限公司
版本历史
目录 第一章代码开发规范及其指南 0 1.1目的 0 1.2程序内命名规范 0 1.3文件命名规范 (1) 1.4J AVA 文件样式 (1) 1.5代码编写格式 (6) 第二章程序编写规范方法 (8) 2.1权限修饰 (8) 2.2其他规范 (8) 2.3编程指南 (10) 第三章其他要求 (12)
第一章代码开发规范及其指南 1.1 目的 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性） 1.2 程序内命名规范 ●Package的命名：Package 的名字应该都是由一个小写单词组成。 ●Class 的命名：Class 的名字必须由大写字母开头而其他字母都小写的单词组 成 ●Class 变量的命名：变量的名字必须用一个小写字母开头。后面的单词用大 写字母开头。 ●Static Final 变量的命名：Static Final 变量的名字应该都大写，并且指出完整 含义。 ●参数的命名：参数的名字必须和变量的命名规范一致。 ●数组的命名：数组应该总是用下面的方式来命名： byte[] buffer; 而不是 byte buffer[]; ●方法的参数：使用有意义的参数命名，如果可能的话，使用和要赋值的字 段一样的名字： SetCounter(int size){ this.size = size;
工程项目文件编号管理规定 1 范围 本办法适用于工程建设全过程，适用于通用技术文件、项目管理类文件及过程运作文件，包括记录。 2 管理要求 2.1 工程记录必须使用编号。 2.2 对外来文件应保留其文件编号，并根据项目管理需要按公司的文件编号模式另外编号；凡是对公司发出文件的回复的外来文件，编号原则是在公司发文编号的末尾加字符“H”表示是对发文的回复，且对回复文件的管理要求是与原先发文装订在一起，回复在前，发文在后。 2.3 现场项目部资料员：负责施工现场产生和收集的项目文件资料的归口管理，包括对文件编号的审核检查，及时反映工程文件编号中出现的问题，要求相关人员进行更正或完善。 2.4 项目成员：负责将项目统一编流水号，以保证编号的唯一性和协调性。 3 工程项目编号 项目名称：滨州高新铝电股份有限公司邹平四电8×240t/h锅炉烟气脱硫提效改造和加装湿式电除尘器及引风机扩容改造EPC工程 项目简称：邹平四电脱硫除尘 项目编码:CSCECENG-LC0398 项目名称：滨州市北海信和新材料有限公司北海供热中心一厂4×480t/h锅炉烟气脱硫提效和加装湿式电除尘及引风机升级改造EPC工程 项目简称：北海脱硫除尘 项目编码:CSCECENG-LC0399 4 工程咨询设计成品（文件和图纸）编号 4.1 工程设计成品（文件和图纸）编号模式
工程勘测设计成品编号基本模式表 4.2 编号代码说明 4.2.1 专业代码H：用1位大写英文字母表示，见附录D。 4.2.2 卷号JJ与册号KK：分别用2位阿拉伯数字表示。 4.2.3 卷册修改代码L：表示该卷或卷册图纸第一次修改（A版）、第二次修改（B版）……（无修改可省略）。 4.2.4 套用图标识M，用T表示，见6.5。 4.2.5 图号(流水号)XXX：用3位阿拉伯数字表示（001～999）。 4.3 工程图纸编号示例 4.3.1 示例一：施工图设计，电气专业，第1卷，第2册，第3号图纸： 卷册检索号为CSCECENG-LC0399-D0102 图号为LC0399-D0102-003 4.3.2 示例二：施工图设计，机务专业，第3卷，第1册，第2号图纸： 卷册检索号为CSCECENG-LC0399-J0301 图号为LC0399-J0301-002 4.4 工程设计图纸（成品）套用图纸编号规定 4.4.1 直接采用已审定批准的标准设计图纸或其他工程勘测设计图纸，在图面上不再修改，均称为套用图纸。
QB ****公司企业标准 信息分类和编码 第3分册工程信息分类和编码 （初稿） 20XX-XX-XX 发布 20XX -XX -XX 发行 *****有限责任公司 发 布 ICS XXX 备案号XXX
目次 前言 (3) 引言 (4) 1范围 (5) 2规范性引用文件 (5) 3术语和定义 (5) 4分类原则和方法 (6) 4.1基本原则 (6) 4.2分类对象的层面划分 (6) 4.3工程信息分类 (7) 4.4工程信息整体框架 (8) 5编码方法 (9) 5.1基本原则 (9) 5.2码值 (9) 5.3代码组结构和层次 (10) 5.3.1交互定位码 (10) 5.3.2项目编码 (10) 5.3.3管理属性编码 (11) 5.3.4设计属性编码 (11) 5.3.5合同属性编码 (12) 5.3.6档案属性编码 (12) 5.3.7采购、财务、招标信息属性编码 (13) 5.3.8非项目信息编码 (13) 6分类与代码表 (14) 6.1非项目信息分类标识码(30301) (14) 6.2省电网公司及直属单位编码(30302) (14) 6.3工程项目建设管理单位代码(30303) (15) 6.4项目属性代码(30304) (18) 6.5综合指标(30305) (19) 6.6立项时间(30306) (20) 6.7批次项目标识码(30307) (21) 6.8信息属性码分类(30308) (21) 6.9项目阶段代码((30309) (22) 6.10工作分解代码(30310) (22) 6.11信息创建部门代码(30311) (23) 6.12设计资料分类代码(30314) (24) 6.13设计阶段代码(30315) (24) 6.14类目代码(30316) (25)
软件开发代码规范（C#版） 拟制: 日期：2007-2-13 审核: 日期： 审核: 日期： 批准: 日期： 版权所有********有限公司
修订纪录
目录 1、第一章命名规范 (4) 1.1、第一节总则 (4) 1.2、第二节变量命名规范 (4) 1.2.1、CodeBehind内部命名规范 (4) 1.2.2、控件命名规范 (5) 1.3、第三节常量命名规范 (5) 1.4、第四节命名空间、类、方法命名规范 (5) 1.5、第五节接口命名规范 (6) 1.6、第六节命名规范小结 (6) 2、第二章代码注释规范 (6) 2.1、第一节模块级注释规范（命名空间、类等） (6) 2.2、第二节方法级注释规范 (7) 2.2.1 、属性注释 (7) 2.2.2 、方法注释 (7) 2.3、第三节代码间注释规范 (8) 3、第三章编写规范 (9) 3.1、第一节格式规范 (9) 3.2、第二节编程规范 (9) 3.2.1 、程序结构要求 (9) 3.2.2 、可读性要求 (10) 3.2.3 、结构化要求 (10) 3.2.4 、正确性与容错性要求 (10) 3.2.5 、可重用性要求 (11) 3.2.6 、interface使用注意事项 (11) 3.2.7 、类使用注意事项 (11) 3.2.8 、流程控制语句注意事项 (12) 3.2.8 、其他应注意事项 (13) 注：Pascal命名法则：即名称中所有单词的第一个字母大写其他字母使用小写形式。 Camel命名法则：即名称中第一个单词各个字母全部小写，其他部分遵循Pascal命名法则。
1、第一章命名规范 1.1、第一节总则 1．本命名规则除特殊提及外统一使用Camel命名法则。 如：controlMenu 2．命名时尽量不使用拼音，更不可使用拼音缩写（专有名词除外）。 3．如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。 如：LuX则命名时，不要写成LUX，或者Lux，而应该保持与原品牌名称风格一致使用LuX 4．使用专有名词或英文缩写命名时采用大写形式。 如：CNNIC 5．禁止使用仅区分大小写的方式命名。 如：Abc与abc仅用大写A来区分，这样写在类C系语言中不会出错，但是不利于系统的迁移 1.2、第二节变量命名规范 1.2.1、CodeBehind内部命名规范 1．公有字段/属性使用Pascal 命名规则，私有变量/保护变量/局部变量使用Camel命名规则，遵循动宾结构。 例： public class Hello { private string userName; private DateTime loginTime; private bool isOnline; public string UserName { get { return https://www.doczj.com/doc/0d15027617.html,erName; } } } 2．即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名，如i 或j 3．在变量名中使用互补对，如Min/Max、Begin/End 和Open/Close。 4．当一个方法内部变量繁多的时候，可以使用Camel命名法则，其中第一个单词可以使用变量类型的缩写来说明以示区别。 例：
.NET编码规范 .NET编码规范 版本：V1.0
.NET编码规范 目录 1介绍 (1) 1.1目的 (1) 1.2范围 (1) 1.3参考文档 (1) 2规范概述 (1) 3规范详述 (1) 3.1文件组织 (1) 3.1.1源文件 (1) 3.1.2目录安排 (2) 3.2缩进 (2) 3.2.1分行 (2) 3.2.2空白 (2) 3.3注释 (3) 3.3.1块注释 (3) 3.3.2单行注释 (3) 3.3.3文档注释 (3) 3.4变量声明 (4) 3.4.1每行声明的数量 (4) 3.4.2初始化 (4) 3.5类和接口的声明 (4) 3.6命名约定 (5) 3.6.1大写风格 (5) 3.6.2命名规则 (6) 3.6.3class，struct和namespace命名规则 (6) 3.6.4interface命名规则 (6) 3.6.5enum命名规则 (6) 3.6.6域命名规则 (7) 3.6.7参数命名规则 (7) 3.6.8变量命名规则 (7)
.NET编码规范 3.6.9方法命名规则 (7) 3.6.10属性命名规则 (7) 3.6.11事件命名规则 (8) 3.7代码细节规范 (8)
1 介绍 1.1 目的 本文件的目的是描述用.NET编写代码过程中应遵循的规范，以确保编写出强壮可靠、符合规范的应用程序。虽然这里的代码示例是用C#编写的，但如果使用另外一种编程语言，其中的大多数规则和原理也是适用的。对于.net开发人员，应力求遵守此文档中的规范，代码审查时，此文档将作为重要的参考依据。 1.2 范围 本文件适用于用.NET来实现的软件产品在编码实现过程中应遵循的规范。 1.3 参考文档 [说明本文件的参考文档。] 2 规范概述 本规范为实现过程中用.NET来进行编码时应遵循的规范，主要内容包括：文件组织、缩进、注释、变量声明、类和接口的声明、命名约定及代码细节规范。 在实现过程中的编码实现，代码走查活动中使用到此规范。 3 规范详述 3.1 文件组织 3.1.1 源文件 把每个类都放在单独的文件中，文件名字和类名一致（用.CS作为扩展名）。严禁将多个命名空间/类放在同一个源文件中（https://www.doczj.com/doc/0d15027617.html,自动生成的除外）。
建筑工程第一章：土（石）方工程1、土方工程（编码010101）（1）平整场地（2）挖土方：土方开挖、运输（3）挖基础土方：土方开挖、挡土板支拆、截桩头、基底钎探、土方运输（4）冻土开挖：开挖、运输（5）挖淤泥、流砂：开挖、运输（6）管沟土方：土方开挖、挡土板支拆、土方运输、回填2、石方工程（编码010102）（1）预裂爆破（2）石方开挖：爆破、岩石开凿、清理运输（3）管沟石方：石方爆破、开凿、石方运输、回填3、??土石方回填|（编码010103）1（1）土（石）方回填：取土、回填第二章：桩与地基基础工程1、砼桩（编码010201）（1）预制|土方：土方开挖、挡土板支拆、截桩头、基底钎探、土方运输（4）冻土开挖：开挖、运输（5）挖淤泥、流砂：开挖、运输（6）管沟土方：土方开挖、挡土板支拆、土方运输、回填2、石方工程（编码010102）（1）预裂爆破（2）石方开挖：爆破、岩石开凿、清理运输（3）管沟石方：石方爆破、开凿、石方运输、回填3、??土石方回填|（编码010103）1（1）土（石）方回填：取土、回填第二章：桩与地基基础工程
1、砼桩（编码010201）（1）预制钢筋砼桩：砼制作、砼运输、桩制作、打桩、送桩（2）接桩（3）砼灌注桩：砼制作、砼运输、灌注砼桩 2、其他桩（编码010202）（1）砂石灌注桩：成孔、填充、振实（2）灰土挤密桩：成孔、填充、振实（3）旋喷桩：成桩、旋喷（4）喷粉桩：成孔、喷粉2、地基与边坡处理（编码010203）（1）地下连续墙（2）振冲灌注碎石（3）地基强夯（4）锚干支护：砼制作、砼运输、钻孔灌浆、挂网、砼喷射（5）土钉支护：砼制作、砼运输、砂浆土钉、挂网、砼喷射第三章、砌筑工程1、砖基础（编码010301）（1）砖基础：砂浆制作（定额内包括）、砼制作、砼运输、夯实、垫层铺设、砌筑、抹防潮层2、砖砌体（编码010302）（1）实心砖墙：砂浆制作、运输（定额内包括）、砌筑、砌砖碹、砖过梁、砌砖压顶（包括在砌筑中）（2）空斗墙（3）空花墙：砂浆制作、运输（定额内包括）、砌筑（4）填充墙（5）实心砖柱：砂浆制作、运输（定额内包括）、砌筑（6）零星砌砖：砂浆制作、运输（定额内包括）、砌筑 3、砖构筑物（编码010303）（1）、砖烟囱、水塔：砂浆制作、运输（定额内包括）、筒身砌筑、内衬砌筑、涂隔绝层、砖加工（2）砖烟道：砂浆制作、运输（定额内包括）、烟道砌筑、内衬砌筑、涂隔绝层、砖加工
项目编码规范 1 命名规范 1）.包名采用域后缀倒置的加上自定义的包名，采用小写字母。 在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。 格式： com.huawei.产品名.模块名称 com.huawei.部门名称. 项目名称 示例： Relay模块包名 com.huawei.msg.relay 通用日志模块包名 com.huawei.msg.log 2）. 类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。 示例： OrderInformation, CustomerList, LogManager, LogConfig 3）. 方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。 示例： private void calculateRate(); public void addNewOrder(); 4）. 方法中，存取属性的方法采用setter 和 getter方法，动作方法采用动词和动宾结构。格式： get + 非布尔属性名() is + 布尔属性名() set + 属性名() 动词() 动词 + 宾语() 示例： public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show();
public void addKeyListener(Listener); 5）.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。 示例： private customerName; private orderNumber; private smpSession; 6). 常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。 示例： public final static int MAX_VALUE = 1000; public final static String DEFAULT_START_DATE = "2001-12-08"; 7). 属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。 示例： public class Person { private String name; private static List properties; public void setName (String name) { https://www.doczj.com/doc/0d15027617.html, = name; } public void setProperties (List properties) { Person.properties = properties; } } 8).如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。 示例： getCustomerInformation() 改为 getCustomerInfo() 2 程序注释规范 1)、基本注释（必须加）
标识规范 沈阳东大阿尔派软件股份有限公司（版权所有，翻版必究）
文件修改控制
目录 1. 目的 2. 适用范围 3. 术语和缩略语 4. 标识规则 4.1 标识对象 4.2 文档版本控制 4.3 发行版本控制 4.4 软件项标识方式 4.5 不合格品的标识 5. 引用文件 5.1 NW602102《文件编号规定》 6. 质量记录 6.1 NR602101A“文件备份清单”
1．目的 为便于标识、控制和追踪软件开发过程中产生的各种软件项及介质，特制定本文件。 2．适用范围 适用于软件开发过程中所需的各种软件项及介质。 3．术语和缩略语 本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。 4．标识规则 4.1 标识对象 标识对象主要包括：技术文档（可行性分析报告、需求分析报告、开发计划、质 量计划、系统设计报告、技术报告、测试计划等）、提交产品（计算机程序、释 放产品等），主要通过介质标识和版本控制以便于存取和查阅。 4.2 文档版本控制 对于计划性文档、技术文档和用户文档，其版本按修改的先后顺序确定。新生成 的文档第一次发行为第一版，修改后第二次发行为第二版，以此类推。 4.3 发行版本控制 最终完成的软件版本用三位符号表示：“s.xy”。各符号位的含义如下： 1）“y”为第二次版本号，表示纠正错误时的版本升级，用一位数字表示：“1~9”，对上一次产品或项目中的缺陷做修正，第二次版本号增加；
2）“x”为第一次版本号，表示增加功能时的版本升级，用一位数字表示：“0~9”。与上一产品或项目相比，功能进行了小量的增加或修正时，第一次 版本号增加，第二次版本号为零，第二版本号为零时可以省略不写； 3）“s”为主版本号，用一位数字表示：“1~9”。对产品作重大调整，或与已发行的上一产品相比，在功能与性能上有较大改善时主版本号增加，次版本号 为零，产品或项目概念全新，第一次完成，版本号为1.0。 4.4 软件项标识方式 4.4.1 技术文档标识方式 技术文档的标识体现在相应文件的封面上，由开发人员参照相应文档模板的格式 要求，对技术文档进行标识。 技术文档编号用十五位符号表示：“xxxxxxxxxxxttnn”。各符号位的含义如下：1）“xxxxxxxxxxx”为本次开发的项目编号，共十一位，具体含义见NW602102《文件编号规定》； 2）“tt”为文档类别代号，用两位大写字母表示。“tt”的取值范围如下：FA(Feasibility Analysis)：可行性分析报告 RA(Requirement Analysis)：需求分析报告 DP(Developing Plan)：开发计划 QP(Quality Plan)：质量计划 SD(System Design)：系统设计报告 TR(Technical Report)：技术报告 SR(Summary Report)：项目开发总结报告 本部分未给出代号的文档，其代号由相应的文档编写部门确定。
软件项目开发和管理规范 本文阐述软件项目开发和管理的流程规范，作为软件项目开发的高级指引，本规范定义了软件开发的各个阶段以及每个阶段的工作活动和工件，但不对活动和工件的细节作过多规定。在项目开发过程中，每个项目根据自身的需要确定这些活动和工件的细节。 项目阶段 图2-1 项目开发的五个阶段 ?启动阶段 这个阶段的工作目的是决定一个项目是否需要启动。为了达到这个目的，首先要明确项目的总体战略目标，对项目的需要建立认同。即确定到底需要做什么、开发什么产品或提供什么服务，以及需要解决什么样的问题和需要满足客户或市场的什么要求等，同时还要总结项目工作的范围、所需资源、大约开支、各种风险，以及该项目不执行的其他替代选择等。这些代表了对整个项目目标从战略角度和宏观层次所进行的分析，通过项目的意向书总结出来，由此确证客户或项目发起人和赞助者的要求与期望，并帮助他们判定项目是否上马。项目意向总结书的通过及项目被批准上马形成了这个项目的起始点。 ?计划阶段 这个阶段的工作是为整个项目做计划。项目开始后，首先要确定项目的具体范围，明确定出项目到底要做什么，总结、归纳并定出产品的功能。然后进一步制定项目的计划，列出每项具体工作，并建立所有工作任务的重要性及顺序；确定每项工作的执行人和所需资源；根据人员的配置和能力设定各项工作和整个项目的完成时间表。 ?执行阶段
这个阶段的工作是通过执行项目的计划来完成项目的任务。它包括落实一切所需资源，如：人员、设备、费用、技术、信息，由管理者领导全体项目参与者开展各项工作。同时跟踪各项具体工作和整个项目的进度，定期向全体项目人员及项目的发起人报告项目状态。 ?控制阶段 这个阶段的工作是确证项目工作的结果符合项目的计划。它通过对项目结果的衡量和审核，与项目计划所期望的结果进行比较，找出实际结果与计划的差别，并制定处理措施。这个阶段的工作还包括对项目进程中出现的任何更改要求进行审核和批准。同时调解项目进程中出现的各种问题，如：对缺乏的资源的补偿调节；对项目的进度表及各项具体工作的优先级或顺序的修订。 ?结束阶段 这个阶段的工作是确保项目的最终结果或提交物达到计划的要求，并对完成的结果作可接受的确认。还包括在项目完成之后的收尾工作，对整个项目的经历进行总结，修订项目文档，用户培训等。 阶段完成标志 在项目开发过程中，当一个阶段完成后才会开展下一个阶段的工作；另外，“某个阶段完成”通常被定义为项目的一个里程碑，里程碑标识了项目的进度，它是项目开发和控制的重要参考，对整个项目有重要的意义。因此，“确证某个阶段是否已经完成”的工作非常有重要。 ?每一个阶段的结束以它特定任务的完成为象征 只有当某个阶段中被规定的所有工作任务都完成了，这个阶段才算真正结束，整个项目才可以进入到下一个阶段中去。反过来说，要是阶段中某个任务没有全部完成，按照项目的定义，整个阶段就不能算是完成，因此项目就不能进入到下一个阶段去。 ?衡量阶段结束的工作结果必须是实在的交付品 阶段中的任务是否完成是透过任务活动中产生的交付品来体现的，交付品必须是可交付的、非抽象的、实质的并且可以通过用衡量的方法来判断是否真正地完成了的具体事物。如：某一阶段的完成是以建造一个样品或完成某分文件作为象征。任何项目阶段的结束，都应该有这样的实质性东西的完成作为象征。 ?跨阶段的进程以阶段结尾的合格验证和审核来决定 当一个阶段结束时，在进入到下一个阶段之前所需要做的工作应包括对交付品进行合格验证，并检查这一阶段的工作质量和效率，由此判断是否可以进入到下一个阶段。这些检验象征了一个阶段的结尾终点，表示项目的进程离开了上一个阶段而进入了下一个阶段。