软件开发过程文档 vc编码规约

《软件开发过程文档 vc编码规约》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、计算机源代码编写规范(VC编码规范)编号：MPDK/ZY-18-2007修改号：0发放号：发布时间：2007-06-28实施时间：2007-06-28编制：批准：VC编码规范1目的规定科大恒星公司的VC编程规约。2适用范围适合公司所有的VC编程项目。3规范内容3.1工程文件开发工作常常和别的从公司合作进行，各个公司的开发环境个不相同，为了使开发的工程可以简单的意志，请遵守以下的约定。包含文件，库文件必须在DSP或makefile中明确书写。DSP或makefile必须使用相对路径，禁止使用绝对路径。不要使包含文件依赖于VC的环境设

2、定（不要放入Option->Directory中，在自己的DSP文件中书写）。3.1.1包含语句格式#include<…>//系统头文件。#include“…”//应用程序的头文件。系统头文件的场合，必须使用<文件名>的形式。系统头文件放在应用程序头文件的前面。应用程序头文件的场合，必须使用“文件名”的形式。#include和文件名之间用TAB键分隔。禁止使用绝对路径。应用程序头文件的场合、在声明后面写上文件的说明。3.1.2文件的内部格式为了避免重复定义，在头文件中推荐以下形式的书写方法。#ifndef大写字母的INCLUDE文

3、件名_H#define大写字母的INCLUDE文件名_H……文件内容……#endif3.2常量的定义3.2.1格式#defineXXXXX<值>//常量的说明const类型XXXXX=<值>//C++的常量的说明3.2.2说明常量的定义尽量避免“#defineXXXX<値>“的形式。常量名全部用大写的字母书写。const和类型之间用TAB分隔在声明的后面写上场量的说明3.3宏的定义3.3.1格式#define…//宏的说明3.3.2説明作为原则，应尽量不使用C++的宏。替换措施是使用inline函数。inline函数要尽量的小。3

4、.4全局变量和函数3.4.1全局变量作为原则，应尽量避免使用全局变量。在必须使用场合，对全局变量的使用要十分注意。3.4.2全局函数作为原则，应尽量避免使用全局函数。在必须使用的场合，对全局函数的使用要十分注意(对于C++，在一个地方实现，就应该放入一个类中)。3.5外部声明的变量和函数3.5.1格式extern外部变量//外部变量的说明extern外部函数//外部函数的声明3.5.2说明外部变量和函数在使用前必须声明。3.6条件编译3.6.1格式＃ｉｆｄｅｆ条件//注释（or＃ｉｆnｄｅｆ）条件//注释＃ｅｌｓｅ//注释＃ｅｎｄ

5、ｉｆ//注释3.7注释3.7.1格式C风格/*………*/C++风格//………3.7.2说明一般来说，复数行的文件头，函数头等注释用C风格注释，单行的用C++风格注释。资源文件基本的字符串放在资源文件中字符串标识：IDS_COM_?????（共同字符串的场合）IDS_XXX_????（个别字符串的场合，XXX是模块的标识）3.8类定义的一般形式例：类：CYYYXXX//////////////////////////////////////////////////////////////NAME:CYYYXXX//BASECLASS

6、NAME:无//FUNCTION:功能简述////////////////////////////////////////////////////////////classCYYYXXX{private:char*szString;public:CYYYXXX();~CYYYXXX();};类：CYYYYYY//////////////////////////////////////////////////////////////NAME:CYYYYYY//BASECLASSNAME:CYYYXXX//FUNCTION:功能简述/

7、///////////////////////////////////////////////////////////classCYYYYYY:publicCYYYXXX{private:intnNum;public:CYYYYYY();~CYYYYYY();};class：C++中系统指定的KEY,一般情况下必须指定。public、private、protected:记述类中的变量和类的可见度。注：可见度標識（public、private、protected）没指定时,莫认是私有(private)的。类名中YYY用于类的类别区分

8、、比如CGuiXXX是画面类，CDBXXX是用于数据库的类。