CMMI- 软件开发代码编程规范模板下载

广东×××技术股份有限公司1编程规范文件编号HW-SP-IMPT-G01文件状态[]草稿[√]正式发布[]正在修改当前版本V1.0拟制张三日期年月日审核李四日期年月日批准王五日期年月日发布日期年月日生效日期年月日广东×××技术股份有限公司2广东×××技术股份有限公司修订历史记录A-增加M-修订D-删除变更版本号日期变更类型（A*M*D）修改人摘要备注1.0A建立编程规范广东×××技术股份有限公司3广东×××技术股份有限公司4目录1目的......................................................................................................................52使用范围...............................................................................................................53C/C++编程规范...................................................................................................53.1文件结构.......................................................................................................................................53.2程序的版式.................................................................................................................................103.3命名规则.....................................................................................................................................183.4缩进规则.....................................................................................................................................234JAVA编程规范...................................................................................................254.1代码组织与风格........................................................................................................................254.2注解.............................................................................................................................................264.3命名.............................................................................................................................................294.4声明.............................................................................................................................................314.5表达式和语句.............................................................................................................................324.6错误处理和异常事件................................................................................................................334.7可移植性.....................................................................................................................................334.8复用.............................................................................................................................................33广东×××技术股份有限公司51目的定义组织的C/C++，JAVA编程规范，以提高程序的可读性、可靠性。2使用范围适合于公司采用C/C++、JAVA编程语言开发的所有软件项目。3C/C++编程规范3.1文件结构每个C/C++程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C/C++程序的头文件以“.h”为后缀，C程序的定义文件以“.c”为后缀，C++程序的定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀，这里以Windows平台为准）。3.1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例3-1），主要内容有：版权信息文件名称、标识符、摘要当前版本号、作者/修改者、完成日期版本历史信息说明：Description一项描述本文件的内容、功能、内部各部分之间的关系及本文件与其它文件关系等。History是修改历史记录列表，每条修改记录应包括修改日期、修改者及修改内容简述。示例：广东×××技术股份有限公司6/********************************************Copyrights©2006，东信和平智能卡股份有限公司*XXXXXX项目组*Allrightsreserved.**Filename：*Sample.cpp*Indentifier：*EP-PRO-SRC-020620-TST(这里只作为示例)*Description：*这里只作为示例*Version：*V1.0*Author:*张三*Finished：*2006年06月07日*History:*张三2002/06/01V0.9文件创建*张三2002/06/07V1.0修改了……********************************************/广东×××技术股份有限公司7/********************************************Copyrights©2006，东信和平智能卡股份有限公司*XXXXXX项目组*Allrightsreserved.**Filename：*这里填入该文件的名称*Indentifier：*这里填入该文件的标识（参见软件配置管理）*Description：*这里填入该对文件内容的简要描述（一般情况下用中文）*Version：*Vx.x*Author:*填入作者姓名（一般情况下用中文）*Finished：*xxxx年xx月xx日*History:*(作者日期版本说明)*文件修订历史纪录（一般情况下用中文）********************************************///版权和版本声明见示例3-1，此处省略。#ifndefSample_H//防止Sample.h被重复引用#defineSample_H#includestdio.h//引用标准库的头文件#include“MyClass.h”//引用非标准库的头文件……voidFunctionX(…)；//全局函数声明……classSample//类结构声明{广东×××技术股份有限公司83.1.2头文件的结构头文件由三部分内容组成：头文件开头处的版权和版本声明（参见示例3-1）//版权和版本声明见示例3-1，此处省略。#include“Sample.h”//引用头文件……voidFunctionX(…)//全局函数的实现体{…}voidSample::MethodX(…)//类成员函数的实现体{…}示例3-4C++/C定义文件的结构示例3-2版本和版权的声明广东×××技术股份有限公司9预处理块函数和类结构声明等假设头文件名称为Sample.h，头文件的结构参见示例3-3【规则3-2-1】为了防止头文件被重复引用，应当用ifndef/define/endif结构产生预处理块【规则3-2-2】用#includefilename.h格式来引用标准库的头文件（编译器将从标准库目录开始搜索）【规则3-2-3】用#include“filename.h”格式来引用非标准库的头文件（编译器将从用户的目录开始搜索）【建议3-2-1】头文件中只存放“声明”而不存放“定义”在C++语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小【建议3-2-2】不提倡使用全局变量，尽量不要在头文件中出现象externintvalue这类声明3.1.3定义文件的结构定义文件有三部分内容：（1）定义文件开头处的版权和版本声明（参见示例3-1）（2）对一些头文件的引用（3）程序的实现体（包括数据和代码）假设定义文件的名称为Sample.cpp，定义文件的结构参见示例3-4。3.1.4头文件的作用早期的编程语言如Basic、Fortran没有头文件的概念，C/C++语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：示例3-3C/C++头文件的结构广东×××技术股份有限公司10（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。3.1.5目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include目录，将定义文件保存于source目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。3.2程序的版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。