VC编码规范(转)
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 “http://www.cnblogs.com/../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生成文件格式,避免用手工制作头文件/实现文件。
// Constructors //构造 // Attributes //属性, 品质, 特征, 加于, 归结 // Operations //运转, 操作, 实施, 作用, 业务, 工作, 手术, 军事行动 // Overridables //可重载的 // Implementation //实现 每一次类都至少有一个//Implementation,在不同的位置MFC做不同的处理,在编写代码时最好
与MFC这种风格一致。
2.2 文件头部注释
文件头部注释主要是表明该文件的一些信息,其格式如下:
///////////////////////////////////////////////////////////////////
// 文件名 : mange_fun.cxx
// 版本 :
// 目的及主要功 : 系统参数的设定
// 创建日期 : 1999.09.14
// 修改日期 :
// 作者 : ***
// 修改者 :
////////////////////////////////////////////////////////////////
2.3 文件规格化功能键
源文件在编写完毕时,Visual C++提供Alt+F8功能键,进行文件规格化,常使用该按键可使得文件保持规格化(注,Alt+F8功能键对连续两个CASE语句则会发生处理错误,不能规格化)。
3 函数风格
3.1 函数名的约定。
函数名的语义应该能反映函数实现的功能。
对于api函数的命名规则为:
a. 函数一律以api_lm_开头;lm表示此函数为lonicera-mda子系统的函数, pdm模块的函数名以api_lp_开头。
b. 后面的命名以函数语义为基准,如创建一点的函数完整的函数名为api_lm_ceate_point()。
对于DI函数的命名规则:
a. 函数名=lm_+(函数语义)。
b. 对于几个单词组合表达的函数名,各单词之间以_符号分开。
3.2 函数注释
ClassWizard自动生成的函数,如消息响应函数,则不必太多的注释和解释;
对于自行编写的函数,若是系统关键函数,则须在函数实现部分的上方标明该函数的信息,格式如下:
//======================================================================
// 函 数 名:InsureHasOutputInfo
// 功能描述:确保有适当的输出信息
// 输入参数:nProductID:相应的产品ID
// 输出参数:void
// 创建日期:00-2-21
// 修改日期:00-2-21
// 作 者:***
// 附加说明:
//======================================================================
3.3 代码缩进
每一个嵌套的函数块,使用一个TAB缩进(可以设定为3个空格),大括号必须放在条件语句的下一行,单独成一行,便于匹对反大括号应该在单独的一行,在大多数情况下反扩号应有注释内容。举例如下:
if(condition1)
{
while(condition2)
{
…..
…..
}//end while(condition2)
}//end if (condition1)
或者
if(condition1){
while(condition2){
….
….
}//end while(condition2)
}//end if(conditionl)