Visual C++ 编程风格守则.docxVIP

Visual ? C++ ? 编程风格守则? 1引言1.1 本文目的随着越来越多的项目需要Visual ? C++来编写，为了便于各位项目经理、程序员之前交流项目源程序，并且保证源程序的可读性，特制定本《编程风格守则》，本文的读者为项目经理、程序员，以期在编码过程之中，保持一致的风格，有利于软件工程项目的推行。本文在编写上力求求大同、存小异，在编程风格上分为两类，一类为强制风格，意为一定需要遵守，一类为推荐风格，意为希望程序员在编码时按照这样的风格。1.2 背景在软件工程领域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。而目前还没有成文的编码风格文档，以致于很多时候，程序员没有一个共同的标准可以遵守，编码风格各异，程序可维护性差、可读性也很差。目前在编码上也有许多相关的风格约定，包括匈牙利命名法（一种变量的取名办法）、类MFC取名方式，但是针对基于某种编译器的项目完整编程风格守则，目前还是比较少，或者说比较零散。1.3 术语系统：指一个软件工程项目，是一个系统；项目：指一个Visual ? C++项目；Hungarian ? naming：MFC：Microsoft ? Foundation ? Class ? Library；1.4 参考资料MSDN中有关MFC编写风格的文章，互联网上一些有关编写风格的资料（/~kjhay/CpSc372/Week3/Week3.PPT）。2 ?概述每位程序员都有自己的编程风格，因为每位程序员都有自己的学习过程，就象每个人的个性一样，所以编程风格是风彩各异、百花齐放；而从软件工程理论、实践来看，现代软件是多人合作的结晶，编程风格是否统一，直接关系到软件项目的可读性、可维护性、培训，继而对软件开发成本有着直接的关系，编程风格一致，软件项目易培训，其它人员接手老项目的时间缩短，便于程序员之间的交流。编程风格混乱，则其它人员接手老项目时间增长，同时随着项目的不断开发，项目或者单个源程序文件内有着多种编程风格，这样不利于整个项目的开展以及程序员之间的交流。本文在参考业界已有的编码风格的基础上，描述了一个基于Visual ? C++编译器的项目风格，力求一种统一的编程风格，并从项目风格、代码文件风格、函数编写风格、变量风格、注释风格几个方面进行阐述。3 ? ? ? ? ? ? ? 项目风格项目风格指的是针对整个项目，包括项目目录设置、相关库文件设置、Visual ? Studio集成环境设置等等的习惯约定。具体有如下风格守则：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 ?