软件质量QG-21-01软件开发编程指南.docx

.质量管理运作体系文件三级文件 1 引言1.1 编写目的阐明软件开发编程指南编写的目的，并指明读者对象。如果软件开发编程指南在实施过程中可能需要修改，应在此说明。1.2 项目背景应包括项目来源、主管部门及软件概述。1.3 定义列出文档中所使用的专门术语的定义和缩写词的原义。1.4 参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括：需求规格说明书、概要设计说明书、用户手册、测试计划、本文档中引用的其他资料。以下章节按软件开发编程中涉及到的方面，每个方面为一个单独的章节，作一单独的阐述。涉及到的方面包括：功能测试、集成测试、强度测试、确认测试等。1.5 命名规则1.5.1 常量命名列出常量命名中，前缀的规则，大小写的规则，常量长度的定义等。 宏定义命名 根据使用的语言，定义宏定义的大小写规则，书写的定义1.5.2 变量命名基本规则定义变量命名的规则，比如：举C语言的例子：程序中所有变量的命名遵循以下的组成规则：<作用域名>+<类型前缀名>+<自定义名>其中作用域名区分函数内局部变量、模块内全局变量和全局变量；类型前缀名是单个或几个不同基本数据类型的组合；变量的自定义名字由英文字母和数字组成，使用大小写字母区分各单词，首字符为大写英文字母。整个变量名的总长度不设限制（只要符合C编译器的规定就行）。1.5.3 作用域名变量的作用域名主要分函数内有效的局部变量、模块内有效的全局变量和全局变量（在整个应用范围内有效的变量），以及对于这些变量的命名规则1.5.4 函数命名定义函数的命名规则如：函数名的组成为<模块名>+<自定义功能名>，所有的公共库函数必须都有模块名，比如TCP/IP通讯类的公共库函数，此类函数应有模块名如为tcp，则所有对外开放的库函数调用都应以tcp开头，例如tcpConnect()可以是TCP/IP类公共库函数的一个调用名。所有非公共库函数名的定义中，模块名可以被省略。自定义功能名的命名方法与变量命名中的自定义名一致。1.5.5 文件命名文件命名指源程序文件、嵌入式源程序文件、头文件、数据文件、配置文件、日志文件、命令文件、SQL命令文件、帮助文件、二进制可执行文件等的命名规则。1.5.6 目录树结构及命名对于软件开发中各级目录树的命名规则1.6 注释使用规范1.6.1 共同性规则共同性规则指源程序和头文件中通用注释根据注释在源程序中说明对象的不同，注释可以大致分为程序功能注释、变量功能注释、函数功能注释、算法描述注释和修改标识注释几类，在以下的几个小节中将会具体描述各类注释的使用规范1.6.2 源程序功能说明根据具体的语言，定义源程序的功能注释规则1.6.3 变量功能说明变量主要通过取用合适的名字来说明变量的意义或功能，而不是靠使用注释来说明其用法，但有需要的话，可在此定义其注释规则1.6.4 函数功能说明函数功能说明的规则1.6.5 过程算法描述过程算法描述的规则1.6.6 修改标识说明修改标识主要是在程序中指明是在何时由何人修改了程序，配合过程算法描述可以说明修改部分的前因后果。修改标识的组成为：<Name Initial>+<Modification Date>1.7 数据说明及定义规范数据说明的规范。1.8 函数说明及定义规范函数说明的规范1.9 语言使用及书写规范本章中对语言中部分常用的语句给出使用的规则，同时也规定部分禁用的语句。1.10 嵌入式SQL语句使用及书写规范嵌入式SQL语句在程序中的规范1.11 头文件结构规范1.12 源程序结构规范1.13 其他书写规范;QG-21-01软件开发编程指南 第 1-4 页 共 4 页