VC编码规范例.docVIP

1??? 项目风格 ???1.1??? 项目取名 ?????在VC之中，项目名为最后可执行文件名，所以项目名最好以最终的可执行文件名一致。 ???1.2??? 项目目录设置 ?????为保证VC项目的备份方便、快捷，将所有该项目有关的文件全部放到统一的目录之下，为每个项目在该目录之下建立一个目录，项目之间的公共部分建立在public目录之下，项目所需要的基础库根据所需要的基础库数目分别建立不同的目录，项目相关的测试程序都统一放在TEST目录之下。下表显示了一个软件工程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 第三方公用模块 ? ???1.3??? 集成环境内的项目目录设置 ???????每个项目在VC编成编辑环境的设置都采用相对路径的设置，不可采用绝对路径，保证其备份到光盘设备后或恢复到硬盘时，?不需要再过多的设置就可直接编译。同样在用#include 语句时不要太多的目录搜索，如下所示： ????????????#include “../../../somehead.h” ????????????改成: ????????????#include headfile.h ????????????或#incldue dir/headfile.h ????????????并注意#include headfile.h与#include headfile.h的区别 (Project Setting)中加入该头文件的所在目录。 ????? ???1.4??? 项目修改记录追踪 ???????每一个VC项目必须存在Changes.Log，用以记载项目产生以来所有的改动，其格式必须如下： 日期： 2000/4/28 修改人： ** 修改主题：? 相关修改文件： hello.cpp 修改内容详细描述： 另外可充分利用Visual C++自动生成的Readme.txt文件来记载项目相关的信息。? ? 2???? 文件风格 ????2.1??? 文件生成 ??????文件名的语义应该能概括表达本文件所包含函数主要实现什么功能。文件名用小写英文字母表达，严禁使用中文；对于几个单词组合表达的文件名，单词之间用_符号分开。 文件名的后缀定义： ??????????a． VC自动生成的源文件和头文件后缀分别为：*.cpp和.h。 ???????????b． 其他源文件和头文件后缀分别为：*.cxx和*.hxx。 VC派生类，尽量用Class Wizard生成文件格式，避免用手工制作头文件/实现文件。 ? // Attributes //属性, 品质, 特征, 加于, 归结 ? // Operations //运转, 操作, 实施, 作用, 业务, 工作, 手术, 军事行动 ? // Overridables //可重载的 ? // Implementation //实现 ???????每一次类都至少有一个//Implementation，在不同的位置MFC做不同的处理，在编写代码时最好 ???????与MFC这种风格一致。 ????2.2??? ????????文件头部注释主要是表明该文件的一些信息，其格式如下： /////////////////////////////////////////////////////////////////// // 文件名??