计算机源代码编写规范.docxVIP

计算机源代码编写规范

文件编号：

NW506104

生效日期：

2000.3.20

受控编号：

密级：秘密

版次：Ver2.1

修改状态：

总页数

6

正文

6

附录

0

编制：马云生

审核：袁淮

批准：孟莉

沈阳东大阿尔派软件股份有限公司

（版权所有，翻版必究）

计算机源代码编写规范Ver2.1P-2/6

沈阳东大阿尔派软件股份有限公司

文件修改控制

修改记录编号

修改状态

修改页码及条款

修改人

审核人

批准人

修改日期

计算机源代码编写规范Ver2.1P-3/6

沈阳东大阿尔派软件股份有限公司

目录

1.目的

2.适用范围

3.术语及缩略语

4.规范内容

4.1标识符命名及书写规范

4.2注释规则

4.3缩进规则

计算机源代码编写规范Ver2.1P-4/6

沈阳东大阿尔派软件股份有限公司

1.目的

良好的编程风格是提高程序可靠性非常重要的手段，也是大型项目多人合作开发的技术基础。本规范的目的在于通过规范定义来避免不好的编程风格，增强程序的易读性，便于自己和其它程序员理解。

2.适用范围

本规定适用于所有软件的源程序编写。客户有特殊要求时，则遵循客户提出的要求。对于移植性开发或低版本的升级开发，则按照前一版本的格式要求。

3.术语及缩略语

本程序采用NQ402100《质量手册》中的术语和缩略语及其定义。

4.规范内容

4.1标识符命名及书写规则

4.1.1基本规则

1)这里的标识符是指编程语言中语法对象的名字，它们有常量名、变量名、函数名、类和类型名、文件名等，标识符的基本语法是以字母开始，由字母数字及下划线组成的单词。

2)标识符本身最好能够表明其自身的含义，以便于使用和他人阅读。按其在应用中的含义由一个或多个词组成。可以是英文词或中文拼音词。

3)当标识符由多个词组成时，每个词的第一个字母大写，其余全部小写，常量标识符全部大写。中文词由中文描述含义的每个汉字的头一个拼音字母组成。英文词尽量不缩写，如果有缩写，在同一系统中对同一单词必须使用相同的表示法。

4)标识的总长度不要超过32个字符。

4.1.2特殊约定

有的编程工具或项目开发小组对标识符的命名有自己的规定，例如，把标识符分为两部分：

规范标识前缀+含义标识

计算机源代码编写规范Ver2.1P-5/6

沈阳东大阿尔派软件股份有限公司

1)规范标识前缀用来标明该标识的归类特征，以便与其它类型的标识互相区别，例如：字符串变量标识符的前缀为str，某字符串变量可命名为：strExample；文本框对象标识符的前缀为txt，某文本框对象的命名可为：txtExample；

2)含义标识用来标明该标识所对应的被抽象的实体，以便记忆，上面例子中“strExample”的“Example”就是含义标识。编程工具或项目开发小组有特殊约定的，以他们的约定为准。

4.1.3源代码文件标识符命名规则

源代码文件标识符分为两部分，即文件名前缀和后缀。格式、规则如下：×××……××.×××

1）前缀部分通常与该文件所表示的内容或作用有关。可以由项目组成员统一约定。

2）后缀部分通常表示该文件的类型，可以自己给定，具体的编程环境有特殊规定的以编程环境的规定为准。

3）前缀和后缀这两部分字符应仅使用字母、数字和下划线。文件标识的长度不能超过32个字符，以便于识别。

4.2注释及格式要求

注释总是加在程序的需要一个概括性说明或不易理解或易理解错的地方。注释应语言简炼、易懂而又准确，所采用的语种首选是中文，如有输入困难、编译环境限制或特殊需求也可采用英文。

4.2.1源代码文件的注释

1)在文件的头部必须标明程序名称，它所完成的主要功能。

2)文件的作者，