Visual-C++-编码规范课件.doc

VisualC++编码规范

1引言

1.1本文目

伴随越来越多项目需要VisualC++来编写,为了便于各位项目经理、程序员之前交流项目源程序,而且确保源程序可读性,特制订本《编程风格守则》,本文读者为项目经理、程序员,以期在编码过程之中,保持一致风格,有利于软件工程项目推行。本文在编写上努力争取求大同、存小异,在编程风格上分为两类,一类为强制风格,意为一定需要遵守,一类为推荐风格,意为期望程序员在编码时根据这么风格。

1.2背景

在软件工程领域,源程序风格统一标志着可维护性、可读性,是软件项目一个关键组成部分。而现在还没有成文编码风格文档,以致于很多时候,程序员没有一个共同标准能够遵守,编码风格各异,程序可维护性差、可读性也很差。

现在在编码上也有很多相关风格约定,包含匈牙利命名法（一个变量取名措施）、类MFC取名方法,不过针对基于某种编译器项目完整编程风格守则,现在还是比较少,或者说比较零碎。

1.3术语

系统:指一个软件工程项目,是一个系统;

项目:指一个VisualC++项目;

Hungariannaming:

MFC:MicrosoftFoundationClassLibrary;

1.4参考资料

MSDN中相关MFC编写风格文章,互联网上部分相关编写风格资料

2概述

每位程序员都有自己编程风格,因为每位程序员都有自己学习过程,就象每个人个性一样,所以编程风格是风彩各异、百花齐放;而从软件工程理论、实践来看,现代软件是多人合作结晶,编程风格是否统一,直接关系到软件项目可读性、可维护性、培训,继而对软件开发成本有着直接关系,编程风格一致,软件项目易培训,其它人员接手老项目时间缩短,便于程序员之间交流。编程风格混乱,则其它人员接手老项目时间增加,同时伴随项目不停开发,项目或者单个源程序文件内有着多个编程风格,这么不利于整个项目开展以及程序员之间交流。

本文在参考业界已经有编码风格基础上,描述了一个基于VisualC++编译器项目风格,努力争取一个统一编程风格,并从项目风格、代码文件风格、函数编写风格、变量风格、注释风格多个方面进行叙述。

3项目风格

项目风格指是针对整个项目,包含项目目录设置、相关库文件设置、VisualStudio集成环境设置等等习惯约定。具体有以下风格守则:

3.1项目取名

在VC之中,项目名为最终可实施文件名,所以项目名最好以最终可实施文件名一致。

3.2项目目录设置

为确保VC项目备份方便、快捷,可将全部该项目相关文件全部放到统一目录之下,为每个项目在该目录之下建立一个目录,项目之间公共部分建立在public目录之下,项目所需要基础库依据所需要基础库数目分别建立不一样目录,项目相关测试程序都统一放在TEST目录之下。下表显示了一个软件工程PSS系统目录设置表:

PSS系统介绍:

PSS系统有两个模块PSS_mod1和PSS_mod2,两个模块有一部分共用代码,在工程开发过程之中编写了三个测试程序PSS_TEST1、PSS_TEST2、PSS_TEST3,PSS系统开发过程之中用到了第三方公用模块Third_Mod,则该系统目录设置以下:

一级目录

二级目录

三级目录

备注

WORK

PSS_mod1

Debug

VC集成环境生成调试版本目录

Release

VC集成环境生成发行版本目录

Res

VC集成环境生成资源文件目录

Include

所属mod1头文件

Source

所属mod2头文件

PSS_mod2

Debug

VC集成环境生成调试版本目录

Release

VC集成环境生成发行版本目录

Res

VC集成环境生成资源文件目录

Include

所属mod1头文件

Source

所属mod2头文件

PUBLIC

Include

Mod1和mod2公用头文件

Source

Mod1和mod2公用源代码文件

Lib

Mod1和mod2公用库文件

TEST

PSS_Test1

测试项目一

PSS_Test2

测试项目三

PSS_Test3

测试项目三

Third_Mod

第三方公用模块

3.3集成环境内项目目录设置

每个项目在VC编成编辑环境设置都采取相对路径设置,不可采取绝对路径,确保其备份到光盘设备后,恢复到硬盘后,不需要再过多设置就可直接编译。一样在用#include语句时不要太多目录搜索,以下所表示:

#include“../../../somehead.h”

改成:

#include“somehead.h”

然后在项目设置(ProjectSetting)中加入