织梦CMS - 轻松建站从此开始!

罗索实验室

当前位置: 主页 > 基础技术 > C/CPP专题 >

Visual C++ 编程风格守则

罗索客 发布于 2002-06-23 16:07 点击:次 
随着越来越多的项目需要Visual C++来编写,为了便于各位项目经理、程序员之前交流项目源程序,并且保证源程序的可读性,特制定本《编程风格守则》,本文的读者为项目经理、程序员,以期在编码过程之中,保持一致的风格,有利于软件工程项目的推行。
TAG:

1 引言
1.1    本文目的
随着越来越多的项目需要Visual C++来编写,为了便于各位项目经理、程序员之前交流项目源程序,并且保证源程序的可读性,特制定本《编程风格守则》,本文的读者为项目经理、程序员,以期在编码过程之中,保持一致的风格,有利于软件工程项目的推行。本文在编写上力求求大同、存小异,在编程风格上分为两类,一类为强制风格,意为一定需要遵守,一类为推荐风格,意为希望程序员在编码时按照这样的风格。
1.2    背景
在软件工程领域,源程序的风格统一标志着可维护性、可读性,是软件项目的一个重要组成部分。而目前还没有成文的编码风格文档,以致于很多时候,程序员没有一个共同的标准可以遵守,编码风格各异,程序可维护性差、可读性也很差。
目前在编码上也有许多相关的风格约定,包括匈牙利命名法(一种变量的取名办法)、类MFC取名方式,但是针对基于某种编译器的项目完整编程风格守则,目前还是比较少,或者说比较零散。
1.3    术语
系统:指一个软件工程项目,是一个系统;
项目:指一个Visual C++项目;
Hungarian naming:
MFC:Microsoft Foundation Class Library;
1.4    参考资料
MSDN中有关MFC编写风格的文章,互联网上一些有关编写风格的资料(http://www.cs.clemson.edu/~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,则该系统的目录设置如下:
一级目录二级目录三级目录备注
WORKPSS_mod1DebugVC集成环境生成的调试版本目录
ReleaseVC集成环境生成的发行版本目录
ResVC集成环境生成的资源文件目录
Include所属mod1的头文件
Source所属mod2的头文件
PSS_mod2DebugVC集成环境生成的调试版本目录
ReleaseVC集成环境生成的发行版本目录
ResVC集成环境生成的资源文件目录
Include所属mod1的头文件
Source所属mod2的头文件
PUBLICIncludeMod1和mod2公用的头文件
SourceMod1和mod2公用的源代码文件
LibMod1和mod2公用的库文件
TESTPSS_Test1测试项目一
PSS_Test2测试项目三
PSS_Test3测试项目三
Third_Mod 第三方公用模块

3.3    集成环境内的项目目录设置
每个项目在VC编成编辑环境的设置都采用相对路径的设置,不可采用绝对路径,保证其备份到光盘设备后,恢复到硬盘后,不需要再过多的设置就可直接编译。同样在用#include 语句时不要太多的目录搜索,如下所示:
#include “../../../somehead.h”
改成:
#include “somehead.h”
然后在项目设置(Project Setting)中加入该头文件的所在目录。
3.4    集成环境内的模块划分
在VC项目集成环境之下,Project视图中的FileView视图,对于每个项目的子模块都建立相应的文件夹,以对不同的子模块进行区分,比如说PSS_mod1就可建立如下几个模块:
核心数据结构、底层通用平台、界面处理模块、底层工作线程,其中底层通用平台又可划分为CJ60开发包、RCC通讯平台等等。

3.5    项目修改记录追踪
每一个VC项目必须存在Changes.Log,用以记载项目产生以来所有的改动,其格式必须如下:
日期:          2000/4/28
修改人:       程旷
修改主题:        底层通讯由于MODEM响应代码而引起的不稳定现象
相关修改文件: CommLayer.cpp
修改内容详细描述:

另外充分利用Visual C++自动生成的Readme.txt文件来记载项目相关的信息。

(iwgh)
本站文章除注明转载外,均为本站原创或编译欢迎任何形式的转载,但请务必注明出处,尊重他人劳动,同学习共成长。转载请注明:文章转载自:罗索实验室 [http://www1.rosoo.net/a/200206/946.html]
本文出处: 作者:iwgh
顶一下
(0)
0%
踩一下
(0)
0%
------分隔线----------------------------
发表评论
请自觉遵守互联网相关的政策法规,严禁发布色情、暴力、反动的言论。
评价:
表情:
用户名: 验证码:点击我更换图片
栏目列表
将本文分享到微信
织梦二维码生成器
推荐内容