C++设计编码规范
（试用版）
设备开发部黄焕斌
目录
重要提示错误!未定义书签。
背景错误!未定义书签。
1文件组织规则错误!未定义书签。
命名错误!未定义书签。
目录错误!未定义书签。
预处理错误!未定义书签。
注释错误!未定义书签。
2代码组织规则错误!未定义书签。
空行错误!未定义书签。
换行错误!未定义书签。
空格错误!未定义书签。
对齐错误!未定义书签。
就近原则错误!未定义书签。
精简原则错误!未定义书签。
3命名规则错误!未定义书签。
自注释错误!未定义书签。
变量错误!未定义书签。
函数错误!未定义书签。
类型错误!未定义书签。
宏错误!未定义书签。
常量错误!未定义书签。
4设计规则错误!未定义书签。
识别类和函数错误!未定义书签。
构造函数错误!未定义书签。
封装性错误!未定义书签。
函数参数错误!未定义书签。
函数返回值错误!未定义书签。
契约错误!未定义书签。
规模错误!未定义书签。
名字空间错误!未定义书签。
类型转换错误!未定义书签。
常量错误!未定义书签。
内联错误!未定义书签。
静态变量错误!未定义书签。
编译依赖错误!未定义书签。
可重入错误!未定义书签。
5内存管理规则错误!未定义书签。
模块化错误!未定义书签。
静态分配错误!未定义书签。
new/delete 错误!未定义书签。
有效性错误!未定义书签。
正确释放错误!未定义书签。
拷贝错误!未定义书签。
6注释规则错误!未定义书签。
有效性错误!未定义书签。
普通注释错误!未定义书签。
Doxygen注释错误!未定义书签。
定义错误!未定义书签。
申明错误!未定义书签。
模块错误!未定义书签。
7维护规则错误!未定义书签。
消除警告错误!未定义书签。
代码修改错误!未定义书签。
标本兼治错误!未定义书签。
参考资料错误!未定义书签。
重要提示
本规范中的示例代码都在表格框中显示，绿色的表格框表示正确的示例代码，红色的表格框表示不建议的示例代码。
背景
C++是大华设备软件和平台软件开发的主要软件，在新的软件框架里，两种平台的组件甚至是共用的。统一的代码风格，良好的设计风格，有利于代码的实现和阅读，有利于减少代码错误和提高代码效率，能有效地促进技术的交流和发展。
常见的代码规范都异常冗长，调调框框太多。本规范力求以简明的内容，概括一些重要的规则，将相似的规则进行提炼集中描述，并提供对照的示例代码加深理解。规范的使用者花半个小时左右，就可以熟悉整个规范。
所有大华基于新软件框架的底层组件，业务组件，应用组件都必须遵守此规范。
例外
本规范是强制要求，不过有些情况例外：
与第三方库有关的代码：比如stl,boost,json等等，使用、移植这些库时，相关的代码可以按照这些库的规范。
Windows代码：主要指基于公共软件框架，同时使用了非公共组件框架内的其他API接口的组件，可以继续保留Windows的规范。
文件组织规则
命名
所有的目录和文件名使用大写字母开头的单词组合，目录名单词之间可以用空格分开。
引用文件名时要严格区分大小写。
与操作系统关系密切的工程的命名可以参考操作系统的规则。
空格
‘，’之后要留空格。
如果‘;’不是一行的结束符号，其后要留空格。
二目或三目操作符前后留空格。
但“［］”、“.”、“->”这类操作符和作用于分辨符“::”前后不加空格。
定义
对于类，结构，联合，枚举，函数，宏，自定义类型，名字空间，非局部变量等定义均需要使用Doxygen简要注释。
对于类，结构，联合，枚举等成员使用右置的Doxygen简要注释。
如果变量是用来作为某种标志而不是连续的数值，还应说明每种取值的意义。
申明
对于全局函数或者类的公有函数的申明，或者直接在类定义中实现的公有函数，应使用\brief \param \return \retval \note \sa等命令进行注释，命令内容为空的可以省略，可使用va模板。
对其他申明可以不加注释。
模块
将相同用途的定义或申明进分组成模块，比如API集等等。
使用\defgroup
使用\addtogroup
使用\ingroup (
.]The Pragmatic Programmer - From journeyman to master
[Google]
软件开发规范 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));
软件系统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)
数据库设计和编码规范 Version
目录
简介 读者对象 此文档说明书供开发部全体成员阅读。 目的 一个合理的数据库结构设计是保证系统性能的基础。一个好的规范让新手容易进入状态且少犯错，保持团队支持顺畅，系统长久使用后不至于紊乱，让管理者易于在众多对象中，获取所需或理清问题。 同时，定义标准程序也需要团队合作，讨论出大家愿意遵循的规范。随着时间演进，还需要逐步校订与修改规范，让团队运行更为顺畅。 数据库命名规范 团队开发与管理信息系统讲究默契，而制定服务器、数据库对象、变量等命名规则是建立默契的基本。 命名规则是让所有的数据库用户，如数据库管理员、程序设计人员和程序开发人员，可以直观地辨识对象用途。而命名规则大都约定俗成，可以依照公司文化、团队习惯修改并落实。 规范总体要求 1.避免使用系统产品本身的惯例，让用户混淆自定义对象和系统对象或关键词。 例如，存储过程不要以sp_或xp_开头，因为SQL SERVER的系统存储过程以 sp_开头，扩展存储过程以xp_开头。 2.不要使用空白符号、运算符号、中文字、关键词来命名对象。 3.名称不宜过于简略，要让对象的用途直观易懂，但也不宜过长，造成使用不方 便。 4.不用为数据表内字段名称加上数据类型的缩写。 5.名称中最好不要包括中划线。
6.禁止使用[拼音]+[英语]的方式来命名数据库对象或变量。 数据库对象命名规范 我们约定，数据库对象包括表、视图（查询）、存储过程（参数查询）、函数、约束。对象名字由前缀和实际名字组成，长度不超过30。避免中文和保留关键字，做到简洁又有意义。前缀就是要求每种对象有固定的开头字符串，而开头字符串宜短且字数统一。可以讨论一下对各种对象的命名规范，通过后严格按照要求实施。例如：
软件开发规范 Software Development Specification Version: V1.0 Date: 2010-06-22 Prepared by
Document Revision History文档修订记录
Table of Contents目录 1Introduction 简介5 1.1Purpose 目标5 1.2Scope 范围6 1.3Definitions, Acronyms, and Abbreviations. 术语，缩略词6 1.4References 引用7 1.5Overview 文档组织7 2The Overall Description 概述8 2.1Software Development Organizing 开发团队组织结构8 2.2Project Base Process 项目基本流程9 2.3CMM Base Process CMM基本过程10 2.3.1SCM软件配置管理10 2.3.2SPP 计划策划12 2.3.3SPTO项目追踪16 2.3.4PR同行评审18 2.3.5SQA质量保证19 2.4SDLC 生命周期选择20 2.5Development Process 开发过程21 2.5.1Development Phase 开发阶段21 2.5.2Phase Product 阶段制品22 2.6Role Duty 角色职责23 2.7Constraints 限制24 3Specific Requirements 详细描述25 3.1Precondition 前提25 3.1.1SCM配置库25 3.1.2Test Environment 测试环境26 3.2Development Control Process 开发控制流程26 3.2.1项目启动和策划阶段27 3.2.2需求分析、设计、编码阶段27 3.2.3提交测试阶段27 3.2.4生产发布、终测28 3.2.5发布后问题反馈修改过程28 3.3TSP 团队软件过程30 3.3.1会议组织30 3.3.2沟通问题30 3.3.3代码走查30
审批及颁发： 部门签名日期起草质量保证部 主审 质量保证部 质量总监 会审生产管理负责人 批准质量管理负责人 颁发质量保证部 分发： Copy-1 Copy-2 Copy-3 Copy-4 Copy-5 质量保证部质量控制部设备部技术部销售部Copy-6 Copy-7 Copy-8 Copy-9 Copy-10 行政人事部财务部安全环保部企管部注册部Copy-11 Copy-12 Copy-13 Copy-14 Copy-15 科技项目部采购部仓储部生产部一车间Copy-16 Copy-17 Copy-18 Copy-19 Copy-20 二车间三车间六车间七车间八车间Copy-21 Copy-22 九车间十车间 文件再审记录： 第几次再审审核情况审核人/日期批准人/日期 第次再审 第次再审 第次再审 一、目的 依照GMP要求，确立文件分类与编码规则，便于文件管理和追溯。
二、范围 适用于文件分类与编码管理。 三、职责 1 质量保证部负责文件体系的分类及编码规则，对各文件进行赋码。 2 各部门负责按照原则对文件进行分类管理；各部门起草文件时必须严格遵循文件编码的规 定。 四、术语 无 五、内容 1 文件分类 1.1 一级文件:阐明公司内某一体系的方针，描述体系的文件。主要包括：质量方针、质量管理手册、质量责任制、质量目标。 1.2 二级文件：主要描述为实施体系要素所涉及到的各职能部门的活动，或为完成某项活动而规定的方法。包括： a）技术标准：包括工艺规程、质量标准、方案、报告等。 b）管理标准：包括计划、管理制度、清单、目录等，描述公司各主要过程的管理活动。 c）工作标准：包括部门职责、职务说明书。 d）工厂主文件。 1.3 三级文件：标准操作规程（SOP），描述各管理环节的操作要素和工作流程、具体的操作方法和步骤。 1.4 四级文件：记录、表格、合格证、图纸、标签、证书等。 2 文件编码 2.1 文件分类编码应遵循以下原则： 2.1.1 系统性：统一分类，统一编码。按照文件分类建立编码系统，由质量保证部建立公司管理文件的分类和编码系统。 2.1.2 准确性：文件与编码一一对应，做到一文一码，一旦某文件终止使用，则该文件编码随即作废，不得再次使用。
国家标准(GB 8567－88)软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a．所建议开发的软件系统的名称。 b．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出用得着的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文。 b．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a．功能。 b．性能。 c．输出如报告、文件或数据，对每项输出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据的来源、类型、数量、数据的组织以及提供的频度。 e．处理流程和数据流程。用图表的方式表示出最基本的数据流程和处理流程，并输之以叙述。 f. 在安全与保密方面的要求。 g. 同本系统相连接的其他系统。 h. 完成期限。 2.2 目标 说明所建议系统的主要开发目标，如： a. 人力与设备费用的减少。 b. 处理速度的提高。 c. 控制精度或生产能力的提高。
代码规范文档
目录 1 概述 (5) 1.1 编写目的 (5) 1.2 文档约定 (5) 1.3 预期的读者和阅读建议 (5) 1.4 参考文献 (5) 2 排版要求 (5) 2.1 程序块缩进 (5) 2.2 程序块之间空行 (5) 2.3 长语句和长表达式 (6) 2.4 循环、判断等长表达式或语句 (7) 2.5 长参数 (7) 2.6 短语句 (8) 2.7 条件、循环语句 (8) 2.8 语句对齐 (8) 2.9 函数、过程和结构等语句块 (9) 2.10 程序块分界符 (9) 2.11 操作符前后空格 (10) 2.12 其他 (11) 3 注释 (11) 3.1 有效注释量 (11) 3.2 公司标识 (11) 3.3 说明性文件 (12) 3.4 源文件头 (13) 3.5 函数头部说明 (13) 3.6 注释与代码一致 (14) 3.7 注释内容 (14) 3.8 注释缩写 (14) 3.9 注释位置 (14) 3.10 变量、常量注释 (15) 3.11 数据结构的注释 (15) 3.12 全局变量 (16) 3.13 注释缩排 (16) 3.14 注释与代码之间空行 (17) 3.15 变量定义、分支语句 (17) 3.16 其他 (19) 4 标识符命名 (20) 4.1 命名清晰 (20) 4.2 特殊命名需注释 (21) 4.3 命名风格保持一致 (21) 4.4 变量命名 (21) 4.5 命名规范与系统风格一致 (21) 4.6 其他 (22) 5 可读性 (23) 5.1 运算符优先级 (23)
5.2 避免直接使用数字作为标识符 (23) 5.3 其他 (24) 6 变量、结构 (25) 6.1 公共变量 (25) 6.2 公共变量说明 (25) 6.3 公共变量访问说明 (25) 6.4 公共变量赋值 (26) 6.5 防止局部变量与公共变量同名。 (26) 6.6 严禁使用未经初始化的变量作为右值。 (26) 6.7 其他 (26) 7 函数、过程 (34) 7.1 对所调用函数的错误返回码要仔细、全面地处理。 (34) 7.2 明确函数功能，精确（而不是近似）地实现函数设计。 (34) 7.3 局部变量 (34) 7.4 全局变量 (34) 7.5 接口函数参数 (35) 7.6 其他 (35) 8 可测性 (44) 8.1 调测开关 (44) 8.2 打印信息 (45) 8.3 单元测试 (45) 8.4 集成测试 (45) 8.5 断言使用 (45) 8.6 设置与取消有关测试手段时，不能影响软件功能功能 (48) 8.7 版本维护 (48) 8.8 其他 (48) 9 程序效率 (50) 9.1 编程时要经常注意代码的效率。 (50) 9.2 提高代码效率 (50) 9.3 全局效率高于局部效率 (51) 9.4 提高代码空间效率 (51) 9.5 循环体内工作量最小化 (52) 9.6 其他 (53) 10 质量保证 (56) 10.1 在软件设计过程中构筑软件质量。 (56) 10.2 代码质量保证优先原则 (56) 10.3 只引用属于自己的存贮空间。 (56) 10.4 防止引用已经释放的内存空间。 (56) 10.5 内存及时释放 (57) 10.6 文件句柄及时关闭 (57) 10.7 防止内存操作越界 (58) 10.8 认真处理程序所能遇到的各种出错情况 (59) 10.9 初始化变量 (59) 10.10 数据一致性检查 (59) 10.11 严禁随意更改其它模块或系统的有关设置和配置 (59) 10.12 不能随意改变与其它模块的接口 (59)
软件开发工作规范章程 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编码
质量管理体系过程文件 软件设计编码过程 文件版本信息：
目录 1.目的 设计编码的目的在于设计和实现关于需求的解决方案。保证《需求规格说明书》中的各项要求在设计时都能够得到满足；对项目的编码实现进行质量控制，保证编码实现活动按计划顺利完成并与设计相一致。 2.范围 适用于公司的各类软件项目的系统设计编码过程。 3.术语 无 4.角色与职责
5.入口准则 ●《需求规格说明书》已通过评审。 6.输入 ●《需求规格说明书》 7.流程图 图1: 系统设计编码过程 8.主要活动 系统设计编码过程包括系统设计、系统实现。系统设计是指设计软件系统的体系结构、数据库、模块等，在需求和代码之间建立桥梁，一般分概要设计和详细设计两个阶段；系统实现是指开发人员按照系统设计去编码开发，并进行单元测试、代码走查；在设计编码过程中同时进行用户文档的编制。 8.1.概要设计 概要设计是分析各种设计方案和定义软件体系结构的过程。设计人员在充分了解需求的基础上，依据《需求规格说明书》选用适当的设计方法，分析与设计软件的结构、模块功能。通过系统分解，确定子系统的功能和子系统之间的关系，以及模块的功能和模块之间的关系，编写《概要设计说明书》。《概要设计说明书》必须经过技术评审。 8.1.1.解决方案选择 系统设计时可能会涉及到多种解决方案的选择，如： ●系统实现路线； ●采用的工具和技术； ●产品架构； ●设计模式； ●模块的制作、购买或重用等。 当出现多种候选方案，难以通过简单的方法判断出方案的优劣时，应按照《S_DAR00_决策分析和决定过程》进行决策。
8.1.2.概要设计 概要设计是建立整个软件的体系结构，包括子系统、模块以及相关层次的说明、每一模块的接口定义等。概要设计的主要步骤有： ?选择设计方法； ?识别解决方案的主要组件：根据解决方案的技术架构和分析方法（面向对象、面向结 构），相应确定解决方案的组件模块； ?对候选技术和工具、组件进行评估，确定是进行开发、购买还是复用已有技术（工具 或者组件）。评估开发、购买或复用方案时需要考虑的事项包括：业务方面：可行性、产品成本、经验、投资回报、成熟度及其他因素；企业体系结构方面：解决方案必须 与当前状态和远景状态计划的约束相适应。包括与企业现有系统的集成等；技术方面：安全、组件模块交互标准、数据访问、数据存储、系统服务、开发工具、操作系统等。 ?识别解决方案主要组件的重要属性和关键关系：在前一任务的基础上，对解决方案主 要组件的重要属性和关键关系进行识别； ?进行数据库设计，建立数据库的逻辑模型和物理模型； ?进行用户界面设计，确定整个系统的界面框架以及界面风格； ?形成《概要设计说明书》。 8.1.3.概要设计评审 概要设计的结果应进行技术评审。技术评审由设计人员提出，由项目经理组织召开。技术评审会议应邀请需求分析师、公司的技术专家、开发人员、测试人员等参加。 关于技术评审会议的要求详见《评审过程》。 8.2.详细设计 详细设计可以和概要设计并行进行，但应考虑并行设计不会因概要设计而导致较大的详细设计返工。 8.2.1.详细设计 详细设计是从开发需求的角度描述解决方案的组件、服务和技术的过程。详细设计定义了解决方案的各个组成部分，以及这些组成部分的开发方法和交互方式。详细设计的步骤包括： ?选择用于开发解决方案的技术并完善设计模型：在概要设计的基础上，选择开发解决 方案采用的技术，并且完善对应的设计模型。
目录 软件开发标准化工作流程 1引言 1.1编写目的 说明编写这份软件开发标准化工作流程的目的，指出预期的读者。 1.2适用范围 互联网开发中心所有项目。 1.3定义 列出本文件中用到的专门术语的定义、外文首字母组词的原词组。
1.4流程图 2需求调研 2.1概述 需求调研对于一个应用软件开发来说，是一个系统开发的开始阶段，需求调研的质量对于一个应用软件来说，是一个极其重要的阶段，它的质量在一定程度上来说决定了一个软件的交付结果。怎样从客户中听取用户需求、分析用户需求就成为调研人员最重要的任务。
2.2需求调研 总体而言，需求调研可按照业务流程、业务规则、表单数据、贯穿系统的关系四个方向来进行调研。 ●业务规则 各个流程、功能点等事项的办理，都会有相关约束或条件，那么需要对其前置条件、后置条件、数据验证、条件判断等进行分析调研。调研对象一般为操作员。 ●表单数据 对各个功能点的业务数据、数据项、表单格式、查询条件以及其它相关数据进行明确的分析调研。调研对象一般为操作员。 ●贯穿系统的关系 各个模块或科室之间的数据交换、传递以及数据共享等，需要我们调研人员与各个模块或科室的相关负责人进行多方沟通，确定一个多方满意的需求调研结果。 2.3注意事项 ●调研过程中，用户说的很快，不可能等我们全部记录之后， 再讲下一个问题。因此，只能在笔记本上速记，有时只能记录1、2个关键字。因此，每天调研结束之后，当天晚上必须整理当天的调研情况，写成一份调研日记。整理当天的调研记录时，还要整理出待明确的问题，下一次再找机会与用户再沟通、确认。
●调研的各个阶段，必须出具相关文档或文件，比如调研计划、 流程图、表单样式、报表格式、背景图片、数据项列表、讨论记录、问题列表等。 ●所有疑问必须等到明确的答复，不能出现相互矛盾、似是而 非的需求。需准确理解客户的讲解，如果有问题的先做记录，之后将整理的问题向客户询问，得到明确的结果。需求必须是客户接受和确认的，不能有臆测的需求。 ●要合理安排好时间和进度。有时候客户还有自己要做的事情， 不一定能及时相应。所以必须提前预约好时间，保证整个需求调研的进度。 ●能积极引导客户。当客户出现疑虑，而调研人员能明白且能 做好客户想要的东西的时候，调研人员能及时积极引导客户，详细讲解我们所知道的东西，并能让客户接受与确认。 ●如遇公司有相关原型或产品，调研人员需先详细了解公司的 相关原型和产品，根据成品，找出本地化的差异化需求。 3可行性分析 这个阶段要回答的关键问题：“对于上一个阶段所确定的问题有行得通的解决办法吗？”为了回答这个问题，系统分析员需要进行一次大大压缩和简化了的系统分析和设计的过程，也就是在较抽象的高层次上进行的分析和设计的过程。 可行性研究应该比较简短，这个阶段的任务不是具体解决
编码规范 (V．01仅供内部使用) 一、布局结构规范 每个源程序文件的头部必须包含文件头部说明（文件名称、软件版权、功能说明、系统版本、开发人员、开发时间）和修改记录说明（修改日期、修改人员、修改说明）。 每个函数头部必须包含函数头部说明（使用https://www.doczj.com/doc/4416078501.html,会自动生成XML格式注释框架。）。 二、书写排版规范 2.1、空行 每个函数定义结束之后都要加一个或若干个空行。 在一个函数体内，变量定义与函数语句之间要加空行。 逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 2.2、对齐 程序的分界符‘{’和‘}’永远都单独成行并且位于同一列，同时与引用它们的语句左对齐。 2.3、缩行 用缩行显示程序结构，使排版整齐，缩进量统一使用TAB，而不能用空格补齐。 同层次的代码在同层次的缩进层上。 三、语言规范 3.1、常量 全用大写字母命名，用下划线分割单词。 3.2、变量 声明变量的同时对变量进行初始化，严禁使用未经初始化的变量。 3.3、表达式 如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。 不要有多用途的复合表达式（例如：d = (a = b + c) + r;该表达式既求a 值又求d 值。应该拆分为两个独立的语句：a = b + c;d = a + r;）。 尽量避免含有否定运算的条件表达式（如： if (!(num >= 10))应改为： if
(num < 10)）。 3.4、语句 if 语句本身自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。 3.5、属性 原则上，字段（Field）是不能公开的，要访问字段的值，一般使用属性。属性以简洁清晰的名词命名。 3.6、函数 不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误用异常捕获。 在函数体的“入口处”，对参数和通过其它途径进入函数体内的变量（如文件句柄等）的有效性进行检查。 函数的功能要单一，不要设计多用途的函数。 避免函数有太多的参数，参数个数尽量控制在5 个以内。如果参数太多，在使用时容易将参数类型或顺序搞错。 3.7、注释 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要及时删除。 对于全局数据（全局变量、常量定义等）必须要加注释。 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。 四、命名规范 4.1、命名空间 命名空间构成方法：公司名.产品名[.组件名] 命名空间以.分割的每个节都建立一个文件夹，使命名空间和文件夹保持一致； 4.2、文件 采用小写字母命名文件，避免取一些比较通俗的文件名，如：main.cs 文件名称应尽量和文件中的类名相同。如：frLogin.cs文件中是frmLogin 类的定义。
软件开发代码规范（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;
附2: 软件文档编写向导 文档分类 项目包括如下几类文档： 项目管理文档。包括：《软件项目计划》、《项目进度报告》、《项目开发总结报告》 软件开发文档。包括：《需求规格说明》、《概要设计说明》、《详细设计说明》、《测试计划》、《软件测试分析报告》。 产品文档。包括：《用户操作手册》《演示文件》。 软件项目计划 （Software Project Plan） 一．引言 1．编写目的（阐明编写软件计划的目的，指出读者对象。） 2．项目背景（可包括：（1）项目委托单位、开发单位和主管部门；（2）该软件系统与其他系统的关系。） 3．定义（列出本文档中用到的专门术语的定义和缩略词的原文。） 4．参考资料（可包括：文档所引用的资料、规范等；列出资料的作者、标题、编号、发表日期、出版单位或资料来源。） 二．项目概述 1. 工作内容（简要说明项目的各项主要工作,介绍所开发软件的功能性能等. 若不编写可行性研究报告,则应在本节给出较详细的介绍。) 2. 条件与限制（阐明为完成项目应具备的条件开发单位已具备的条件以及尚需创造的条件. 必要时还应说明用户及分合同承包者承担的工作完成期限及其它条件与限制。） 3. 产品 （1）程序（列出应交付的程序名称使用的语言及存储形式。） （2）文档（列出应交付的文档。） （3）运行环境（应包括硬件环境软件环境。） 4．服务（阐明开发单位可向用户提供的服务. 如人员培训安装保修维护和其他运行支持。）5．验收标准
三．实施计划 1．任务分解（任务的划分及各项任务的负责人。） 2．进度（按阶段完成的项目,用图表说明开始时间完成时间。） 3．预算 4．关键问题（说明可能影响项目的关键问题,如设备条件技术难点或其他风险因素,并说明对策。） 四．人员组织及分工 五．交付期限 六．专题计划要点（如测试计划等。） 项目开发进度报告 一．报告时间及所处的开发阶段 二．给出进度 1．本周的主要活动 2．实际进展与计划比较 三．所用工时（按不同层次人员分别计时。） 四．所有机时 五．工作遇到的问题及采取的对策 六．本周完成的成果 七．下周的工作计划 八．特殊问题 项目开发总结报告 一．引言 1．编写目的（阐明编写总结报告的目的,指明读者对象。） 2．项目背景（说明项目的来源、委托单位、开发单位及主管部门。） 3．定义（列出报告中用到的专门术语定义和缩写词的原意。） 4．参考资料（列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：（1）项目开发计划；（2）需求规格说明书；（3）概要设计说明书；（4）详细设计说明书；（5）用户操作手册；（6）测试计划；（7）测试分析报告（8）本报告引用的其他资料、采用的开发标准或开发规范。）
公司档案文件编码规则 文件编号 行政类文件的编号，其代号组成： XX1-XX2XX3-XXXX4—XXX5 XX1：企业代号，以大写的公司简体名称拼音表示，本公司以“GY”表示； XX2：文件一级类号，本公司文件类号见下表 XX3：文件二级类号，本公司文件类号见下表 XXXX4：文件年份； XXX5：同类别下文件流水号； 1.1.1.文件编号例： GY-XZ05-2012-001 文件顺序号 年份 文件类别 公司简写 意为共远行政部通知通告类2012年001号文件 一级类目（代码）二级类目 （代码） 归档范围 行政类 XZ 证照 01 各种证照（营业执照正副本，组织机构代码证正副本，税务登记证，生产 许可证，注册证，获奖证，商标证等） 公司战略 02 企业经营战略、决策、发展规划、管理目标等文件材料，董事会决议等 制度 03 公司各项规章制度 合同 04 合同、协议、公证书、意向书、招投标及有关谈判材料 通知通告 05 红头文件，通知，通报等 办公文件 06 通联文件（上级下达的文件，下级上报的文件，平行部门往来文件等） 各职能部门工作总结，报告，计划等文件
会议 07 公司级会议文件（报告，纪要，记录，简报，发言材料等）政府文件 08 公司申请、批复等有关材料（项目文件，产品注册文件等） 活动09 公司印刷、汇编材料、大事记等 公司大型活动的议程，领导讲话，照片、录音、录像等资料 其它 10 其它类型文件 销售类 XS 市场 01 新市场开拓、新项目论证、评价、市场调查、分析、预测等文件材料销售政策 02 产品销售价格及调价政策等有关材料 其它 03 其它销售类文件 技术类 JS 分析报告 01 产品质量分析报告，样品问题反馈报告等项目 02 项目的调研立项报告、请示、批复等 产品设计定型、改型、改进报告、批复其它 03 其它技术相关文件 生产类SC 生产 01 生产统计报告，发货统计报告，库存盘点报告，质量统计报告等其它 02 其它生产相关文件
软件开发代码规范（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/4416078501.html,erName; } } } 2．即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名，如i 或j 3．在变量名中使用互补对，如Min/Max、Begin/End 和Open/Close。 4．当一个方法内部变量繁多的时候，可以使用Camel命名法则，其中第一个单词可以使用变量类型的缩写来说明以示区别。 例：
GB8567－88软件开发主要文档编写规范
GB8567－88软件开发主要文档编写规范
233 GB 8567－88软件开发主要文档编写规范 本附录中列出了《计算机软件产品开发文件 编制指南》GB 8567－88中主要软件文档的编写说明，供编写时参考。这些文档主要是：可行性研究报告、项目开发计划、软件需求说明书、概要设计说明书、详细设计说明书、模块开发卷宗、测试计划、测试分析报告、项目开发总结报告。 一、 可行性研究报告 l 引言 1.1 编写目的 说明：说明本可行性研究报告的编写目的，指出预期的读者。 1.2 背景 说明： a ．所建议开发的软件系统的名称。 b ．本项目的任务提出者、开发者、用户及实现该软件的计算中心或计算机网络。 c ．该软件系统同其他系统或其他机构的基本的相互来往关系。 1.3 定义 列出本文件中用到的专门术语的定义和 外文首字母组词的原词组。
234 1.4 参考资料 列出用得着的参考资料，如： a ．本项目的经核准的计划任务书或合同、上级机关的批文。 b ．属干本项目的其他已发表的文件。 c. 本文件中各处引用的文件、资料，包括所需用到的软件开发标准。 列出这些文件资料的标题、文件编号、发表 日期和出版单位，说明能够得到这些文件资料的来源。 2 可行性研究的前提 说明对建议开发项目进行可行性研究的前 提，如要求、目标、条件、假定和限制等。 2.1 要求 说明对所建议开发软件的基本要求，如： a ．功能。 b ．性能。 c ．输出如报告、文件或数据，对每项输 出要说明其特征，如用途、产生频度、接口以及分发对象。 d. 输入说明。系统的输入包括数据 的来源、类型、数量、数据的组织以及提供的频
质量管理体系过程文件软件设计编码过程
文件版本信息：
目录 1.目的 (3) 2.围 (3) 3.术语 (3) 4.角色与职责 (3) 5.入口准则 (3) 6.输入 (3) 7.流程图 (3) 8.主要活动 (4) 8.1.设计原则 (4) 8.2.设计方法.................................................................................... 错误!未定义书签。 8.3.多方案选择 (4) 8.4.概要设计.................................................................................... 错误!未定义书签。 8.4.1.概要设计............................................................................ 错误!未定义书签。 8.4.2.概要设计评审.................................................................... 错误!未定义书签。 8.5.详细设计.................................................................................... 错误!未定义书签。 8.5.1.详细设计 (5) 8.5.2.详细设计评审 (6) 8.6.编码............................................................................................ 错误!未定义书签。 8.7.单元测试 (7) 8.8.代码走查 (7) 8.9.制作用户文档............................................................................ 错误!未定义书签。 8.10.变更............................................................................................ 错误!未定义书签。 9.输出 (8) 10.出口准则 (8) 11.引用文档 (8)
软件开发过程规范范文 1. 前言 1.1 目的 本规范的目的是使整个软件产品开发及项目工程阶段清晰，要求明确，任务具体，便于规范化、系统化及工程化。有利于提高软件生命周期的控制及管理，提高所开发软件的质量，缩短开发时间，减少开发和维护费用，使软件开发活动更科学、更有成效。 1.2 对象 本规范面向产品生命周期的所有相关人员，包括管理人员、开发人员、质管人员。 1.3 要求 具有软件开发管理职能的人员要求熟知项目开发的各阶段过程和各阶段过程相应的规范。 1.4 适用范围 适用于产品开发生命周期中的除产品提交外的其他全部过程；规范分为两部分：技术过程规范和管理过程规范，分别适用于软件开发过程中的技术性活动和管理性活动。 1.5 软件开发过程模型 本规范所采用的软件开发过程模型为简化的RUP开发过程模型；软件开发过程是体系结构为中心，用例驱动和风险驱动相结合的过程迭代。 1.6 开发过程划分 开发过程包括多次迭代，每次迭代的目标和侧重点不同；较早的迭代侧重于业务建模和需求建模；而后的迭代则侧重于分析设计和编码。 2. 技术过程规范部分 2.1 概述 本规范中将软件开发的整个技术过程分为四个顺序实施的阶段，分别为业务建模阶段、需求阶段、分析设计阶段和实现阶段。在对技术过程规范的描述，按阶段内部的活动和产物对四个阶段分别说明。 在本规范中对阶段内活动的说明，是按顺序性活动和持续性活动两类分别进行说明。
对于顺序性活动是按该阶段中活动的总体顺序进行的描述，而在实际工作中，从各活动的具体实施的细节来看，各活动之间的顺序是不断交叉变化的。对于持续性活动主要是对贯穿该阶段过程始终的技术活动进行说明。 规范中所提到的可选文档是指在其所属阶段，可根据具体情况灵活掌握，开发团队自主决定是否开发的文档产物。而提交文档则是指在项目开发过程中必须开发的文档产物，但可根据具体项目情况，在软件开发计划中明确规定是否要形成正式文档并提交。 规范中各阶段提到的技术评审，具体参见《评审规范》中所对应技术性评审的详细描述。 2.2 业务建模阶段 2.2.1 顺序性活动描述 1)开始初步调研，获取初始业务需求，进行问题定义，形成《业 务概览》并建立《术语表》； 2)制定《调研记录表册》，实施详细的业务调研，建立初始的 业务用例模型和《业务用例规格》； 3)分析业务过程，取出可以实现自动化的用例，分析业务部门 和实体对象，形成初始的业务对象模型； 4)根据初始业务对象模型和初始业务用例模型，分析并提取与 系统实现相关的用例和模型，建立系统域模型； 5)精化域模型中的初始用例，详细描述业务流程，分析业务规 则，建立精化的业务用例模型，形成《业务规则》和《业务 用例规格》； 6)精化域模型中的初始对象，进行详细的对象描述，分析对象 职责和对象间关系，建立精化的业务对象模型，形成《业务 对象纵览》； 7)分析业务上的非功能性需求，形成《增补业务规格》； 8)应用业务对象，实现业务用例，制定《业务用例实现规格》， 以验证业务对象与业务用例的正确性，根据验证结果，修正 业务对象、业务用例及相关文档； 9)汇总《业务规则》《业务用例规格》《业务对象纵览》《增 补业务规格》和《业务用例实现规格》形成《业务架构文档》。 2.2.2 持续性活动描述 1)《业务概览》在业务建模阶段，根据对项目理解的不断加深， 随时进行改进； 2)《术语表》的更新维护； 2.2.3 提交文档 1)《业务概览》 2)《术语表》 3)《调研记录表册》 4)《业务架构文档》其附件包括：《业务规则》《业务用例规