软件开发流程管理制度及软件开发流程规范

软件开发流程管理制度（讨论稿）为加强对定制软件开发工作管理，缩短开发周期，提高软件开发质量，降低开发成本，提高定开发效率和效益，特制定软件开发流程管理制度。第一章、总则为保证日常工作正常有序的进行，让开发中各个环境更紧凑，更可控，需要尽可能实现项目管理的正规化，工作过程的流程化，以便提高软件质量，按期交付。1、软件开发总体遵循项目管理和软件工程的基本原则。2、项目管理涉及项目立项、项目计划和监控、配置管理。3、软件工程涉及需求分析、系统设计、软件实现、系统测试、用户测试、试运行、系统验收、系统上线和数据迁移、产品维护。第二章、阶段成果根据软件工程的过程，制定以下工作流程，并规定了各个重要环节需要提交的交付物。各阶段需提交的文档：1、立项：项目申请表，软件需求报告或设计方案。2、需求分析：项目研发主计划、需求规格说明书3、总体设计：概要设计说明书或功能模块描述4、详细设计：详细设计说明书，包括软件接口说明、单元测试计划。5、软件实现：软件功能说明、源代码说明或者注释6、产品测试：测试报告7、产品发布：产品说明书、使用手册8、产品维护：问题反馈记录9、项目总结：提交客户方的项目总结和公司项目汇报的PPT。软件过程成果表：阶段形成文档职责及文档成果描述负责人涉及范围备注需求阶段项目立项报告(Word)明确甲乙双方责任及义务，需双方签字确认项目经理验收报告大部分业务建模和需求，少部分分析设计业务需求说明书(Word)需求定义，阐述业务范围及内容，开发组负责制定最优技术设计方案项目经理/分析员验收报告项目开发计划(Project)用户、领导、项目组都了解项目进度项目经理验收报告设计阶段业务流程总体设计书、详细设计说明书(Word/Visio)项目组成员分配任务，并召开讨论会议，讨论项目的技术架构和可能存在的技术难点，梳理业务流程，统一开发规则和风格等项目经理/分析员验收报告大部分分析设计，部分实施编程及测试，开始考虑部署数据库关系设计图、流程图(PowerDesigner)便于项目开发分析员验收报告任务分配文档(Word)明确每个组员的开发任务及职责项目经理过程报告问题说明报告(Word)让用户、领导及组员及时了解和发现问题项目经理过程报告业务变更文档(Word)记录开发过程中用户提出的业务需求变更情况分析员过程报告测试阶段项目测试方案及报告(Word)记录项目测试的方法，验证系统功能与性能的记录测试员验收报告反复测试直至系统稳定用户使用手册(Word)方便用户使用软件而提供的使用说明书测试员验收报告上线及运行系统切换报告系统部署后的操作记录项目经理过程报告部署及维护用户培训报告用户培训文档项目经理过程报告项目验收报告(Word)记录甲乙双方签订项目验收报告项目经理验收报告项目总结性报告项目组通过此项目总结经验及不足项目经理总结报告第三章、岗位设置根据公司目前的开发过程主要分为分析、开发、测试三个阶段。分析阶段完成用户需求文档的编写，系统总体设计的编写；开发阶段完成设计文档的编写，代码的编写、代码的维护。测试阶段完成系统的测试，测试文档及其他材料。通过逐渐的调整岗位，明确工作职责，逐步实现项目经理，软件设计师，程序员，测试工程师的岗位设置。岗位工作内容责任项目经理1、选定项目组成员，成立项目组，安排任务分工2、与客户进行沟通和协调(业务需求或非业务需求方面)，以及需求调研工作。3、制定开发主计划，包括需求，设计，编码，测试这几个阶段的计划。4、估计项目开发费用5、制定小组开发进度表,对组内人员工作进度监控。6、和客户进行沟通，进行需求调研，汇总需求分析文档，并编写系统总体设计方案7、对文档的质量进行检查、把关8、对组内成员的工作进行指导1、对客户的沟通协调工作负责；2、对软件的开发效率、质量、费用负责3、对用户的需求分析的质量负责；4、对系统总体设计、详细设计文档质量负责软件设计师1、负责系统的模块设计，详细设计文档2、绘制界面原型demo等，设计功能使用的具体描述、行为者、前置条件、后置条件、UI描述、业务流程/子流程/分支流程，界面说明等，完成大部分的前端设计，小部分的后端设计。3、负责技术难度大的模块的代码或者公用模块代码的编写、维护4、对自己负责模块的详细设计、代码编写。5、对小组内人员进行技术指导1、对组内人员的开发效率负责；2、对产品整体风格负责3、对项目整体设计流程负责；4、对自己模块的开发效率和质量负责。程序员1、与项目经理沟通和确认某个模块的需求和实现方法2、负责某个模块的代码编写、维护3、对其他模块的代码的维护4、负责与测试人员的交互，处理测试人员的问题1、对自己模块的开发效率和质量负责。测试工程师1、根据用户需求分析和系统总体设计，编写测试文档和测试用例。2、对系统的功能、性能、异常进行测试。3、编写测试文档和操作指导手册。1、对测试的质量负责2、对测试文档和操作手册的质量负责。第四章、项目立项1、分析人员进行应用调查与分析，确认软件的应用需求。2、成立项目评审会，开发总监、部门经理和指定人员必须参加。对项目进行可行性研究，编写项目建议书，评估项目的难度和工作量，形成可行性研究报告。3、根据项目配置的优劣成立项目开发组，制定软件开发计划，确定项目经理，由部门和项目经理共同来确定具体项目配置，知识技能要求，团队成员及团队的角色。第五章、项目计划与监控1、以项目为单位，项目经理负责整个项目的计划、组织和控制。2、在整个项目过程中，项目经理定期检查项目进度和完成情况，调整人员分工和安排。3、项目计划需要变更时，需要明确变更内容并及时汇报。项目经理需要说明客户变更原因并将变更说明提交公司领导审核，以便根据变更内容及时调整计划。。第六章、需求分析1、对用户提出的需求进行分析汇总，梳理用户的业务流程和详细的功能定义。2、做出简单的界面原型，与客户进行有效的沟通，编写需求详细说明书。3、根据现有条件进行估计，制定项目进度，制定详细的软件开发计划。第七章、总体设计1、在该阶段确定总体结构和软件开发架构，文件命名规范，编码规范。可按软件需求划分成子系统，也可直接定义目标系统的功能模块及各个功能模块的关系。3、确定软件模块结构，给出每个功能模块的功能描述、数据接口描述，并完成系统概要设计说明书。4、完成数据库的设计，并编写数据库设计说明书。5、完成的文档需提交公司进行归档管理。第八章、详细设计1、调整前一步设计的不足，确认各模块之间的详细接口信息。2、设计功能使用的具体描述、行为者、前置条件、后置条件、UI描述、业务流程/子流程/分支流程，界面说明等。3、确定模块内的数据流或控制流，对每个程序模块必须确定所有输入、输出和处理功能。4、汇总并提交所有相关文档，审核确认质量和进度。第九章、软件实现1、项目组根据概要设计说明书、详细设计说明书制定系统实现计划2、有条件的情况下保证开发、测试和生产环境独立。选择软件工具，明确项目成员的职责分工，按照编码规范和详细设计实现软件功能。3、代码应满足结构良好，清晰易读，且与设计一致，符合编码规范。4、开发人员需要软件实现过程中编写软件功能说明，源代码说明。软件功能说明文档应说明项目名称、编号、软件名称和版本号，软件功能、主要功能实现过程。源代码说明应说明项目编号、软件名称、功能，全局变量、数据库字典、函数功能、接口。该文档包含在源代码文件中，以注释形式存在。5、项目组进行单元测试和集成测试。开发人员处理测试人员反馈的测试问题，并以书面形式反馈主要问题及解决办法，直至系统运行稳定。6、汇总并提交所有相关文档，提交公司备案。第十章、软件测试1、根据单据测试和集成测试两个过程，制定测试计划。按阶段设计测试实例，并将测试结果记录，未通过的的反馈给开发人员调整。2、完成测试文档、操作手册、安装维护手册的编写。第十一章、用户培训1、准备用户培训计划、培训手册2、确定培训时间、培训地点，向用户进行系统使用培训、操作指导及提供软件操作手册。3、保留培训签到表，用户意见等存档。第十二章、系统上线1、制定上线计划，确定上线工作时间表，部署的环境。2、上线操作步骤以及问题处理步骤；3、根据软件特点、客户需求进行软件部署，并记录软件部署和运行结果；4、项目组根据系统运行请款对系统进行优化，记录系统的运行情况、系统问题和处理后的版本。第十三章、系统验收1、验收工作准备，按要求整理项目成果物，打印装订成册，并提交客户方。2、系统主要使用部门及信息技术部门联合成立项目验收小组，从需求功能及技术需求层面对系统进行综合评估和项目成果物的审核，根据验收情况形成系统验收报告3、应用部门及信息技术部门负责人根据系统试运行情况签署验收意见。第十四章、产品维护1、调出项目主要开发人员，按照合同要求安排维护人员对系统进行技术支持。2、系统需求变更或调整，记录变更原因和软件及源代码的版本控制，按照软件变更要求对系统进行维护。第章十五、源码和文档1、源代码/文档管理采用版本控制软件SVN。2、按项目的阶段性完成源代码、文档的上传。项目负责人每天对代码进行检查，开发总监或部门经理定期进行抽查。3、文档分为项目文档和个人文档，文档上传前进行归类和汇总。第十六章、质量检查1、项目负责人每天要检查成员的工作完成情况，特别是新员工的工作进展；2、工作抽查制度：不定期的进行抽检，并将检查对象、检查时间、检查内容、检查结果反馈给被抽检人。3、内部审核制度：针对业务需求、概要设计(功能界面、数据库)或疑难问题组织评审会，提出意见或解决方案。第十七章、文档规范1、需按照软件实施的阶段落实成果物，参照《软件过程提交成果表》。2、如果客户有特殊要求，请按照客户要求的规范完成。并将最终的问题提交公司归档备份。第十八章、软件变更为规范软件变更与维护管理，特制定本制度。本制度适用于应用系统开发完毕并正式上线，移交给客户方之后的运行支持及系统变更工作。1、系统变更工作可分为功能完善维护、系统缺陷修改、统计报表生成。2、需求部门提出系统变更需求，开发部技术支持人员根据重要性和紧迫性做判断，确定其优先级和影响程度，并进行相应处理，同时将变更需求整理成系统变更申请表。3、系统变更实现过程按照软件开发过程规定进行，遵循软件开发过程统一的编码标准和版本控制，并经过测试通过才能完成部署和上线。4、在系统变更完成后，开发人员需将系统变更表的执行结果找业务部门负责人签字后，提交至公司进行归档管理。软件开发流程规范V1.0德联软件有限责任公司编制人：侯秀美审核人：2015年8月19日目录目录 一、概述本文制定烟台开发区德联软件有限责任公司计算机软件开发规范文档。本规范的目的是使公司软件开发项目阶段清晰、要求明确、任务具体、编写的代码规范，使之规范化、系统化和工程化，向公司内从事软件开发的工程师和管理人员提出一系列规范和要求，从而有利于开发过程的控制和管理，提高所开发软件系统的质量，缩短开发时间，减少开发和维护费用，以保证项目高质量、顺利进行。本规范包含：开发流程规范和开发代码规范等，开发流程规范需要技术开发人员编写相关内容，希望每个技术人员形成习惯，如有新的内容更新会及时通知大家，如有好的规范要求也可通知编制人员及时更新。本规范为烟台开发区德联软件有限责任公司内部材料，严禁其他商业应用。二、开发流程规范 接受开发任务，详细阅读软件技术规范或技术文档，如对技术文档有疑义或者不清楚的地方及时与项目总工或用户沟通，根据文档和沟通内容编写项目开发计划，必须包括但不限于系统软硬件开发环境、系统架构、系统功能模块设计、系统功能开发流程图、开发修改记录。2.1系统软硬件开发环境开发环境的搭建，最好形成文档，便于以后同样工作的使用。开发人员要明确系统开发拟采用的数据库、操作系统、开发语言、开发工具、服务器等（具体到版本）。明确整个系统开发工作流程，至少应该包括以下流程。2.2系统架构（系统组成）确定系统整体体系架构，各层次之间的数据流的连接，确定软件服务器的硬件配置及用户硬件资源配置，确定与用户软件平台的统一协调。开发人员在绘制架构图时给出基本框架，能反映出基本意义即可，可以直接用文字代替例子中的图片。图1系统逻辑架构图举例图2物理架构图举例2.3系统功能模块设计给出系统的主要功能模块，每个模块所包含的功能。图3图书管理系统模块规划图举例2.4系统功能开发流程图给出系统主要功能的业务流程图。图4系统功能业务流程图举例2.5开发修改记录1.开发代码做好备份（可以在完成一个重大功能之后，或者按时间周期性进行备份），以免由于不可抗力导致代码不可修复。2.在每次重大修改之后要做好记录（改动的具体细节），修改前的版本要及时备份，可以方面随时还原系统。修改日期修改内容是否备份备注

三、开发代码规范 在研究项目团队协作开发的情况下（这里的团队协作也适合于应用项目的开发），编程时应该强调的一个重要方面是程序的易读性，在保证软件速度等性能指标能满足用户需求的情况下，能让其他程序员容易读懂你所编写的程序。若研究项目小组的所有开发人员都遵循统一的、鲜明的一套编程风格，可以让协作者、后继者和自己一目了然，在很短的时间内看清楚程序结构，理解设计的思路，大大提高代码的可读性、可重用性、程序健壮性、可移植性、可维护性。 制定本编程规范的目的是为了提高软件开发效率及所开发软件的可维护性，提高软件的质量。本规范由程序风格、命名规范、注释规范、程序健壮性、可移植性、错误处理以及软件的模块化规范等部分组成。 此规范以C/C++程序设计讨论。3.1文件结构 每个C++/C程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。 C++/C程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。3.1.1文件信息声明文件信息声明位于头文件和定义文件的开头（参见示例3-1），主要内容有：（1）

版权信息；（2）

文件名称，项目代码，摘要，参考文献；（3）

当前版本号，作者/修改者，完成日期；（4）

版本历史信息；（5）

主要函数描述。

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////Copyright(c)2015,DeLianSoftCompanyYanTai//Allrightsreserved.////Filename：filename.h//ProjectCode：Theprojectcodeaboutthisfile//Abstract：Describethecontentofthisfilesummarily//Reference：////Version：1.1//Author：thenameofauthor(mender)//Accomplisheddate：September2,2004////Replacedversion:1.0//OriginalAuthor:thenameoforiginalauthor(mender)//Accomplisheddate:September10,2003////Mainfunctions：// Function1Returncode Functionname(ParameterExplain)// Function2Returncode Functionname(ParameterExplain)// ...// FunctionnReturncode Functionname(ParameterExplain)////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////示例3-1文件信息声明☆

【规则3.1-1】 文件信息声明以两行斜杠开始，以两行斜杠结束，每一行都以两个斜杠开始；☆

【规则3.1-2】 文件信息声明包含五个部分，各部分之间以一空行间隔；☆

【规则3.1-3】 在主要函数部分描述了文件所包含的主要函数的声明信息，如果是头文件，这一部分是可以省略的。3.1.2头文件的结构头文件由三部分内容组成：(1)

头文件开头处的文件信息声明(参见示例3-1)；(2)

预处理块；(3)

函数和类结构声明等。假设头文件名称为filesystem.h，头文件的结构参见示例3-2。☆

【规则3.2-1】 为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块；“#ifndef”或者“#define”后以TAB键代替SPACE键做空格；如果头文件名称是由多个单词组成，则各单词间以下划线“_”连接，例如有头文件名称为“filesystem.h”，则定义如下：“#ifndef _FILE_SYSTEM_H_”；☆

【规则3.2-2】 用#include<filename.h>格式来引用标准库的头文件(编译器将从标准库目录开始搜索)；☆

【规则3.2-3】 用#include“filename.h”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)；☆

【建议3.2-1】 头文件中只存放“声明”而不存放“定义”；☆

【建议3.2-1】 头文件中应包含所有定义文件所定义的函数声明，如果一个头文件对应多个定义文件，则不同定义文件内实现的函数要分开声明，并作注释以解释所声明的函数从属于那一个定义文件；☆

【建议3.2-3】 宏定义和函数声明分离，在两个头文件中定义，如果没有类成员函数，可以将类和结构的定义与函数声明分离，也就是说一个头文件专用于宏定义，一个头文件专用于类和结构的定义，一个头文件专用于函数声明；☆

【建议3.2-4】 在C++语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。头文件的结构如下：//文件信息声明见示例3-1，此处省略。

#ifndef _FILE_SYSTEM_H_ //avoidreferencingthefilefilesystem.hrepeat#define _FILE_SYSTEM_H_#include<math.h> //referencestandardheadfile…#include“myheader.h” //referencenon-standardheadfile…voidFunction1(…); //globalfunctiondeclare…classCBox //classstructuredecalre{…};#endif示例3-2C++/C头文件的结构

3.1.3定义文件的结构定义文件有三部分内容：(1)

定义文件开头处的文件信息声明(参见示例3-1)；(2)

对一些头文件的引用；(3)

程序的实现体（包括数据和代码）。假设定义文件的名称为filesystem.c，定义文件的结构参见示例3-3。//文件信息声明见示例3-1，此处省略。

#include“filesystem.h” //referenceaheadfile…//globalfunctionrealizationvoidFunction1(…){…}

//classmemberfunctionrealizationvoidCBox::Draw(…){…}示例3-3C++/C定义文件的结构3.1.4头文件的作用 早期的编程语言如Basic、Fortran没有头文件的概念，C++/C语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释： （1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码； （2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。3.1.5目录结构 如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。 例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。3.2命名规则 比较著名的命名规则当推“匈牙利”命名法，该命名规则的主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。例如所有的字符变量均以ch为前缀，若是指针变量则追加前缀p。如果一个变量由ppch开头，则表明它是指向字符指针的指针。 “匈牙利”法最大的缺点是烦琐，例如 inti,j,k; floatx,y,z; 倘若采用“匈牙利”命名规则，则应当写成 intiI,iJ,ik;//前缀i表示int类型 floatfX,fY,fZ;//前缀f表示float类型 如此烦琐的程序会让绝大多数程序员无法忍受。 总的说来，没有一种命名规则可以让所有的程序员赞同，且命名规则对软件产品而言并不是“成败悠关”的事，而且在不同的平台和不同的环境下编写的程序所应遵循的规则也不尽相同，所以我们只是追求制定一种令大多数项目成员满意的命名规则，并在项目中贯彻实施。3.2.1共性原则本节论述的共性规则是被大多数程序员采纳的，我们应当在遵循这些共性规则的前提下，再扩充特定的规则，如3.2.2节☆

【规则3.2.1-1】 标识符应当直观且可以拼读，可望文知意，不必进行“解码”；☆

【规则3.2.1-2】 标识符的长度应当符合“min-length&&max-information”原则；☆

【规则3.2.1-3】 命名规则尽量与所采用的操作系统或开发工具的风格保持一致；☆

【规则3.2.1-4】 程序中不要出现仅靠大小写区分的相似的标识符。☆

【规则3.2.1-5】 程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解；☆

【规则3.2.1-6】 变量的名字应当使用“名词”或者“形容词＋名词”；☆

【规则3.2.1-7】 全局函数的名字应当使用“动词”或者“动词＋名词”(动宾词组)；☆

【规则3.2.1-8】 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等；☆

【建议3.2.1-9】 尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号；注：3.2.1

标识符最好采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名，程序中的英文单词一般不要太复杂，用词应当准确，例如不要把CurrentValue写成NowValue；3.2.2

标示符的长度应当以最小的长度实现最多信息，一般来说，长名字能更好地表达含义，但并非长的变量名就一定要比短的变量名要好，此外单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局部变量；3.2.3

不同的操作系统的程序设计风格是不一样的，例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild，而Unix应用程序的标识符通常采用“小写加下划线”的方式，如add_child，别把这两类风格混在一起使用；3.2.2Windows变量命名规则☆

【规则3.2.2-1】 变量的命名规则要求采用“匈牙利法则”，即开头字母用变量的类型，其余部分用变量的英文意思或其英文意思的缩写，尽量避免采用中文拼音，要求单词的第一个字母大写；即：变量名＝变量类型＋变量英文意思(或缩写)变量类型请参见附表1－变量类型表；☆

【规则3.2.2-2】 类名和函数名用大写字母开头的单词组合而成；对struct、union、class变量的命名要求定义的类型用大写，结构采用S开头，联合体采用U开头，类采用C开头；例如：structSPoint{ int m_nX; int m_nY;};unionURecordLen{ BYTE m_byRecordNum; BYTE m_byRecordLen;} classCNode { //类成员变量或成员函数 };☆

【规则3.2.2-3】 指针变量命名的基本原则为：一重指针变量的基本原则为： 变量名＝“p”＋变量类型前缀＋命名对多重指针变量的基本原则为：二重指针：变量名＝“pp”＋变量类型前缀＋命名三重指针： 变量名＝“ppp”＋变量类型前缀＋命名例如一个short*型的变量应该表示为pnStart；☆

【规则3.2.2-4】 全局变量用g_开头；例如一个全局的长型变量定义为g_lFileNum，即：变量名＝g_＋变量类型＋变量的英文意思(或缩写)；☆

【规则3.2.2-5】 静态变量采用s_开头；例如一个静态的指针变量定义为s_plPrevInst，即：变量名＝s_＋变量类型＋变量的英文意思(或缩写)；☆

【规则3.2.2-6】 类成员变量采用m_开头；例如一个长型成员变量定义为m_lCount，即：变量名＝m_＋变量类型＋变量的英文意思(或缩写)；☆

【规则3.2.2-7】 对const的变量要求在变量的命名规则前加入c_(若作为函数的输入参数，可以不加)，即：变量名＝c_＋变量命名规则，例如：constchar*c_szFileName；☆

【规则3.2.2-8】 对枚举类型(enum)中的变量，要求用枚举变量或其缩写做前缀，且用下划线隔离变量名，所有枚举类型都要用大写，例如：enum EMDAYS{ EMDAYS_MONDAY; EMDAYS_TUESDAY; }；☆

【规则3.2.2-9】 对常量(包括错误的编码)命名，要求常量名用大写，常量名用英文意思表示其意思，用下划线分割单词，例如：#define CM_7816_OK 0x9000；☆

【规则3.2.2-10】 为了防止某一软件库中的一些标识符和其它软件库中的冲突，可以为各种标识符加上能反映软件性质的前缀。例如三维图形标准OpenGL的所有库函数均以gl开头，所有常量（或宏定义）均以GL开头。3.3程序风格程序风格虽然不会影响程序的功能，但会影响程序的可读性，追求清晰、美观，是程序风格的重要构成因素。3.3.1空行空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。☆

【规则3.3.1-1】 在每个类声明之后、每个函数定义结束之后都要加空行。参见示例3.3.1(a)；☆

【规则3.3.1-2】 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例3.3.1(b)；

//blanklinevoidFunction1(…){…}//blanklinevoidFunction2(…){…}//blanklinevoidFunction3(…){…}

//blanklinewhile(condition){ statement1; //blankline if(condition) { statement2; } else { statement3; }//blankline statement4;}示例3.3.1(a)函数之间的空行示例3.3.1(b)函数内部的空行

3.3.2代码行☆

【规则3.3.2-1】 一行代码只做一件事情，如只定义一个变量，或只写一条语句,这样的代码容易阅读，并且方便于写注释；☆

【规则3.3.2-2】 if、for、while、do等语句自占一行，执行语句不得紧跟其后，不论执行语句有多少都要加{}，这样可以防止书写失误；☆

【规则3.3.2-3】 if、for、while、do等语句的“{”要单独占用一行；☆

【建议3.3.2-1】 所有函数内的变量都在函数开始处定义；☆

【建议3.3.2-2】 尽可能在定义变量的同时初始化该变量(就近原则)，如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致程序错误，本建议可以减少隐患。示例3.3.2(a)为风格良好的代码行，示例3.3.2(b)为风格不良的代码行。

intnWidth; //widthintnHeight; //heightintnDepth; //depth

intnWidth,nHight,nDepth;//width,height,depth

x=a+b;y=c+d;z=e+f;X＝a+b;y=c+d;z=e+f;

if(nWidth<nHight){ DoSomething();}if(nWidth<nHight)DoSomething();for(initialization;condition;update){DoSomething();}//blanklineOther();

for(initialization;condition;update)DoSomething();Other();

示例3.3.2(a)风格良好的代码行示例3.3.2(b)风格不良的代码行3.3.3代码行内的空格☆

【规则3.3.3-1】 关键字之后要留空格，象const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字，象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字；☆

【规则3.3.3-2】 函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别；☆

【规则3.3.3-3】 ‘（’向后紧跟，‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格；☆

【规则3.3.3-4】 ‘，’之后要留空格，如Function(x,y,z)，如果‘;’不是一行的结束符号，其后要留空格，如for(initialization;condition;update)；☆

【规则3.3.3-5】 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格；☆

【规则3.3.3-6】 一元操作符如“!”、“~”、“++”、“--”、“&”（地址运算符）等前后不加空格；☆

【规则3.3.3-7】 象“［］”、“.”、“->”这类操作符前后不加空格；☆

【建议3.3.3-1】 对于表达式比较长的for语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for(i=0;i<10;i++)和if((a<=b)&&(c<=d))

voidFunc1(intx,inty,intz);//favorablestylevoidFunc1(intx,inty,intz);//illstyleif(year>=2000)//favorablestyleif(year>=2000)//illstyleif((a>=b)&&(c<=d))//favorablestyleif(a>=b&&c<=d)//illstylefor(i=0;i<10;i++)//favorablestylefor(i=0;i<10;i++)//illstylefor(i=0;I<10;i++)//favorablestylex=a<b?a:b;//favorablestylex=a<b?a:b;//illstyleint*x=&y;//favorablestyleint*x=&y;//illstylearray[5]=0;//Donotusearray[5]=0;a.Function();//Donotusea.Function();b->Function();//Donotuseb->Function();

示例3.3.3代码行内的空格

3.3.4对齐☆

【规则3.3.4-1】 程序的分界符‘{’和‘}’应独占一行并且位于同一列，同时与引用它们的语句左对齐；☆

【规则3.3.4-2】 {}之内的代码块在‘{’右边数格处左对齐；☆

【规则3.3.4.3】 代码的的对齐采用TAB键而不采用空格键对齐，一般TAB键设置为向后空4个空格。

示例3.3.4(a)为风格良好的对齐，示例3.3.4(b)为风格不良的对齐。

voidFunction(intx){…//programcode}

voidFunction(intx){…//programcode}

if(condition){…//programcode}else{…//programcode}if(condition){…//programcode}else{…//programcode}for(initialization;condition;update){…//programcode}for(initialization;condition;update){…//programcode}While(condition){…//programcode}while(condition){…//programcode}如果出现嵌套的｛｝，则使用缩进对齐，如： { … { … } …}

示例3.3.4(a)风格良好的对齐示例3.3.4(b)风格不良的对齐3.3.5长行拆分☆

【规则3.3.5-1】 代码行最大长度宜控制在70至80个字符以内；☆

【规则3.3.5-2】 长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符），拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

if((very_longer_variable1>=very_longer_variable12)&&(very_longer_variable3<=very_longer_variable14)&&(very_longer_variable5<=very_longer_variable16)){DoSomething();}virtualCMatrixCMultiplyMatrix(CMatrixleftMatrix,CMatrixrightMatrix);

for(very_longer_initialization; very_longer_condition; very_longer_update){ DoSomething();}示例3.3.5长行的拆分3.3.6修饰符的位置修饰符*和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题，若将修饰符*靠近数据类型，例如：int*x;从语义上讲此写法比较直观，即x是int类型的指针，上述写法的弊端是容易引起误解，例如：int*x,y;此处y容易被误解为指针变量。虽然将x和y分行定义可以避免误解，但并不是人人都愿意这样做。☆

【规则3.3.6-1】 应当将修饰符*和＆紧靠变量名；3.3.7注释C语言的注释符为“/*…*/”。C++语言中，程序块的注释常采用“/*…*/”，行注释一般采用“//…”。注释通常用于：（1）版本、版权声明；（2）函数接口说明；（3）重要的代码行或段落提示。虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例3.3.7。

☆

【规则3.3.7-1】 注释是对代码的“提示”，而不是文档，程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱，注释的花样要少；☆

【规则3.3.7-2】 如果代码本来就是清楚的，则不必加注释；例如i++; //i加1，多余的注释☆

【规则3.3.7-3】 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性，不再有用的注释要删除；☆

【规则3.3.7-4】 注释应当准确、易懂，防止注释有二义性，错误的注释不但无益反而有害；☆

【规则3.3.7-5】 尽量避免在注释中使用缩写，特别是不常用缩写；☆

【规则3.3.7-6】 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方；☆

【规则3.3.7-8】 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读；☆

【建议3.3.7-9】 对于多行代码的注释，尽量不采用“/*...*/”，而采用多行“//”注释，这样虽然麻烦，但是在做屏蔽调试时不用查找配对的“/*...*/”。

//////////////////////////////////////////////////////////////////////Functioncapacity：//Parameterdeclare：//Returnvalue：////////////////////////////////////////////////////////////////////voidFunction(floatx,floaty,floatz){…}

if(…){…while(…){…}//endofwhile…}//endofif示例3.3.7程序的注释3.7.1文件头的注释 文件头的注释请参见3.1，文件头的注释是以两行斜杠开始，以两行斜杠结束(以区别于函数的注释)。3.7.2函数头的注释一般说来每个函数都应该做详细的注释，函数头的注释是以一行斜杠开始，以一行斜杠结束，注释的内容包括“功能”，“参数”，“返回值”，“设计思想”，“调用函数”，“日期”，“修改记录”等几个方面，函数头的注释格式如下：////////////////////////////////////////////////////////////////////////////////////////////////Functioncapacity： Describethefunctioncapacity//Parameterdeclare：// parameter1： Describethefunctionofparameter(input/outputparameter)// parameter2： Describethefunctionofparameter(input/outputparameter)// //Returnvalue：Describethepossiblereturnvalue//Designedidea：Describedesignedideaaboutthefunction//Author： //Creationdate：Creationdate(YY-MM-DD)//Transferredfunction： Listthesub-functioninthefunction//Modificationrecord：// (一)Mender1： Modifieddate： modifiedcontent//////////////////////////////////////////////////////////////////////////////////////////////

3.4函数设计 函数是C++/C程序的基本功能单元，其重要性不言而喻。函数设计的细微缺点很容易导致该函数被错用，所以光使函数的功能正确是不够的。本章重点论述函数的接口设计和内部实现的一些规则。 函数接口的两个要素是参数和返回值。C语言中，函数的参数和返回值的传递方式有两种：值传递（passbyvalue）和指针传递（passbypointer）。C++语言中多了引用传递（passbyreference）。由于引用传递的性质象指针传递，而使用方式却象值传递，初学者常常迷惑不解，容易引起混乱，请先阅读3.4.6节“引用与指针的比较”。3.4.1参数的规则☆

【规则3.4.1-1】 参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字，如果函数没有参数，则用void填充；例如：voidSetValue(intnWidth,intnHeight); //良好的风格voidSetValue(int,int); //不良的风格floatGetValue(void); //良好的风格floatGetValue(); //不良的风格☆

【规则3.4.1-2】 参数命名要恰当，顺序要合理；例如编写字符串拷贝函数StringCopy，它有两个参数，如果把参数 名字起为str1和str2，例如：voidStringCopy(char*str1,char*str2);那么我们很难搞清楚究竟是把str1拷贝到str2中，还是刚好倒过来，可以把参数名字起得更有意义，如叫strSource和strDestination。这样从名字上就可以看出应该把strSource拷贝到strDestination。还有一个问题，这两个参数那一个该在前那一个该在后？参数的顺序要遵循程序员的习惯。一般地，应将目的参数放在前面，源参数放在后面。如果将函数声明为：voidStringCopy(char*strSource,char*strDestination);别人在使用时可能会不假思索地写成如下形式：charstr[20];StringCopy(str,“HelloWorld”); //参数顺序颠倒

☆

【规则3.4.1-3】 如果参数是指针，且仅作输入用，则应在类型前加const，以防止该指针在函数体内被意外修改。例如：voidStringCopy(char*strDestination，constchar*strSource);☆

【规则3.4.1-4】 如果输入参数以值传递的方式传递对象，则宜改用“const&”方式来传递，这样可以省去临时对象的构造和析构过程，从而提高效率；☆

【建议3.4.1-1】 避免函数有太多的参数，参数个数尽量控制在5个以内。如果参数太多，在使用时容易将参数类型或顺序搞错；☆

【建议3.4.1-2】 尽量不要使用类型和数目不确定的参数；C标准库函数printf是采用不确定参数的典型代表，其原型为：intprintf(constchat*format[,argument]…);这种风格的函数在编译时丧失了严格的类型安全检查。3.4.2返回值的规则☆

【规则3.4.2-1】 不要省略返回值的类型；C语言中，凡不加类型说明的函数，一律自动按整型处理，这样做不会有什么好处，却容易被误解为void类型；C++语言有很严格的类型安全检查，不允许上述情况发生。由于C++程序可以调用C函数，为了避免混乱，规定任何C++/C函数都必须有类型。如果函数没有返回值，那么应声明为void类型☆

【规则3.4.2-2】 函数名字与返回值类型在语义上不可冲突；违反这条规则的典型代表是C标准库函数getchar。例如：charc;c=getchar();if(c==EOF)…按照getchar名字的意思，将变量c声明为char类型是很自然的事情。但不幸的是getchar的确不是char类型，而是int类型，其原型如下：intgetchar(void);由于c是char类型，取值范围是[-128，127]，如果宏EOF的值在char的取值范围之外，那么if语句将总是失败，这种“危险”人们一般哪里料得到！导致本例错误的责任并不在用户，是函数getchar误导了使用者☆

【规则3.4.2-3】 不要将正常值和错误标志混在一起返回。正常值用输出参数获得，而错误标志用return语句返回；☆

【建议3.4.2-1】 有时候函数原本不需要返回值，但为了增加灵活性如支持链式表达，可以附加返回值；例如字符串拷贝函数strcpy的原型：char*strcpy(char*strDest，constchar*strSrc);strcpy函数将strSrc拷贝至输出参数strDest中，同时函数的返回值又是strDest。这样做并非多此一举，可以获得如下灵活性：charstr[20];intnLength=strlen(strcpy(str,“HelloWorld”));☆

【建议3.4.2-2】 如果函数的返回值是一个对象，有些场合用“引用传递”替换“值传递”可以提高效率。而有些场合只能用“值传递”而不能用“引用传递”，否则会出错；对于建议3.4.2-2，如果函数的返回值是一个对象，有些场合用“引用传递”替换“值传递”可以提高效率，而有些场合只能用“值传递”而不能用“引用传递”，否则会出错，例如：classString{… //赋值函数 String&operate=(constString&other); //相加函数，如果没有friend修饰则只许有一个右侧参数friend Stringoperate+(constString&s1,constString&s2);private: char*m_data;};String的赋值函数operate=的实现如下：String&String::operate=(constString&other){ if(this==&other) return*this; deletem_data; m_data=newchar[strlen(other.data)+1]; strcpy(m_data,other.data); return*this; //返回的是*this的引用，无需拷贝过程}对于赋值函数，应当用“引用传递”的方式返回String对象。如果用“值传递”的方式，虽然功能仍然正确，但由于return语句要把*this拷贝到保存返回值的外部存储单元之中，增加了不必要的开销，降低了赋值函数的效率。例如： Stringa,b,c; … a=b; //如果用“值传递”，将产生一次*this拷贝 a=b=c; //如果用“值传递”，将产生两次*this拷贝

String的相加函数operate+的实现如下：Stringoperate+(constString&s1,constString&s2){ Stringtemp; deletetemp.data; //temp.data是仅含‘\0’的字符串 temp.data=newchar[strlen(s1.data)+strlen(s2.data)+1]; strcpy(temp.data,s1.data); strcat(temp.data,s2.data); returntemp; }

对于相加函数，应当用“值传递”的方式返回String对象。如果改用“引用传递”，那么函数返回值是一个指向局部对象temp的“引用”。由于temp在函数结束时被自动销毁，将导致返回的“引用”无效。例如： c=a+b;此时a+b并不返回期望值，c什么也得不到，流下了隐患。3.4.3函数内部实现的规则不同功能的函数其内部实现各不相同，看起来似乎无法就“内部实现”达成一致的观点。但根据经验，我们可以在函数体的“入口处”和“出口处”从严把关，从而提高函数的质量。

☆

【规则3.4.3-1】 在函数体的“入口处”，对参数的有效性进行检查；很多程序错误是由非法参数引起的，我们应该充分理解并正确使用“断言”（assert）来防止此类错误。详见4.5节“使用断言”☆

【规则3.4.3-2】 在函数体的“出口处”，对return语句的正确性和效率进行检查；注意事项如下：(1)

return语句不可返回指向“栈内存”的“指针”或者“引用”，因为该内存在函数体结束时被自动销毁，例如： char*Func(void) { charstr[]=“helloworld”; //str的内存位于栈上 … returnstr; //将导致错误 }(2)

要搞清楚返回的究竟是“值”、“指针”还是“引用”；(3)

如果函数返回值是一个对象，要考虑return语句的效率，例如： returnString(s1+s2);这是临时对象的语法，表示“创建一个临时对象并返回它”，不要以为它与“先创建一个局部对象temp并返回它的结果”是等价的，如 Stringtemp(s1+s2); returntemp;实质不然，上述代码将发生三件事。 首先，temp对象被创建，同时完成初始化； 然后拷贝构造函数把temp拷贝到保存返回值的外部存储单元中； 最后，temp在函数结束时被销毁（调用析构函数）。然而“创建一个临时对象并返回它”的过程是不同的，编译器直接把临时对象创建并初始化在外部存储单元中，省去了拷贝和析构的化费，提高了效率。类似地，我们不要将 returnint(x+y); //创建一个临时变量并返回它写成 inttemp=x+y; returntemp;由于内部数据类型如int,float,double的变量不存在构造函数与析构函数，虽然该“临时变量的语法”不会提高多少效率，但是程序更加简洁易读。3.4.4其它建议☆

【建议3.4.4-1】 函数的功能要单一，不要设计多用途的函数；☆

【建议3.4.4-2】 函数体的规模要小，尽量控制在150行代码之内；☆

【建议3.4.4-3】 尽量避免函数带有“记忆”功能。相同的输入应当产生相同的输出带有“记忆”功能的函数，其行为可能是不可预测的，因为它的行为可能取决于某种“记忆状态”。这样的函数既不易理解又不利于测试和维护。在C/C++语言中，函数的static局部变量是函数的“记忆”存储器。建议尽量少用static局部变量，除非必需。☆

【建议3.4.4-4】 不仅要检查输入参数的有效性，还要检查通过其它途径进入函数体内的变量的有效性，例如全局变量、文件句柄等；☆

【建议3.4.4-5】 用于出错处理的返回值一定要清楚，让使用者不容易忽视或误解错误情况。3.4.5使用断言程序一般分为Debug版本和Release版本，Debug版本用于内部调试，Release版本发行给用户使用。断言assert是仅在Debug版本起作用的宏，它用于检查“不应该”发生的情况。示例4.5是一个内存复制函数。在运行过程中，如果assert的参数为假，那么程序就会中止（一般地还会出现提示对话，说明在什么地方引发了assert）。

void*memcpy(void*pvTo,constvoid*pvFrom,size_tsize){ assert((pvTo!=NULL)&&(pvFrom!=NULL)); //使用断言 byte*pbTo=(byte*)pvTo; //防止改变pvTo的地址 byte*pbFrom=(byte*)pvFrom; //防止改变pvFrom的地址 while(size-->0) *pbTo++=*pbFrom++; returnpvTo;}示例3.4.5复制不重叠的内存块

assert不是一个仓促拼凑起来的宏。为了不在程序的Debug版本和Release版本引起差别，assert不应该产生任何副作用。所以assert不是函数，而是宏。程序员可以把assert看成一个在任何系统状态下都可以安全使用的无害测试手段。如果程序在assert处终止了，并不是说含有该assert的函数有错误，而是调用者出了差错，assert可以帮助我们找到发生错误的原因。

☆

【规则3.4.5-1】 使用断言捕捉不应该发生的非法情况，不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的；☆

【规则3.4.5-2】 在函数的入口处，使用断言检查参数的有效性（合法性）；☆

【建议3.4.5-1】 在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查；☆

【建议3.4.5-2】 一般教科书都鼓励程序员们进行防错设计，但要记住这种编程风格可能会隐瞒错误。当进行防错设计时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。3.4.6引用与指针的比较引用是C++中的概念，初学者容易把引用和指针混淆一起。一下程序中，n是m的一个引用（reference），m是被引用物（referent）。 intm; int&n=m;n相当于m的别名（绰号），对n的任何操作就是对m的操作。所以n既不是m的拷贝，也不是指向m的指针，其实n就是m它自己。引用的一些规则如下：（1）

引用被创建的同时必须被初始化（指针则可以在任何时候被初始化）；（2）

不能有NULL引用，引用必须与合法的存储单元关联（指针则可以是NULL）；（3）

一旦引用被初始化，就不能改变引用的关系（指针则可以随时改变所指的对象）。 以下示例程序中，k被初始化为i的引用。语句k=j并不能将k修改成为j的引用，只是把k的值改变成为6。由于k是i的引用，所以i的值也变成了6。 inti=5; intj=6; int&k=i; k=j; //k和i的值都变成了6; 上面的程序看起来象在玩文字游戏，没有体现出引用的价值。引用的主要功能是传递函数的参数和返回值。C++语言中，函数的参数和返回值的传递方式有三种：值传递、指针传递和引用传递。 以下是“值传递”的示例程序。由于Func1函数体内的x是外部变量n的一份拷贝，改变x的值不会影响n,所以n的值仍然是0。 voidFunc1(intx){ x=x+10;}…intn=0; Func1(n); cout<<“n=”<<n<<endl; //n=0 以下是“指针传递”的示例程序。由于Func2函数体内的x是指向外部变量n的指针，改变该指针的内容将导致n的值改变，所以n的值成为10。 voidFunc2(int*x){ (*x)=(*x)+10;}…intn=0; Func2(&n); cout<<“n=”<<n<<endl; //n=10

以下是“引用传递”的示例程序。由于Func3函数体内的x是外部变量n的引用，x和n是同一个东西，改变x等于改变n，所以n的值成为10。 voidFunc3(int&x){ x=x+10;}…intn=0; Func3(n); cout