VC代码书写规范.docx
- 文档编号:3730559
- 上传时间:2022-11-25
- 格式:DOCX
- 页数:15
- 大小:23.97KB
VC代码书写规范.docx
《VC代码书写规范.docx》由会员分享,可在线阅读,更多相关《VC代码书写规范.docx(15页珍藏版)》请在冰豆网上搜索。
VC代码书写规范
VC编程规范
版本1.0,2002-1-30
华工赛百VC开发小组
1排版格式约定
1.1程序块采用缩进风格编写,缩进量以一个TAB为单位,每层嵌套缩进一个TAB。
1.2相对独立的程序块之间、变量说明之后必须加空行。
空行一般为1-3行,不允许存在不规则的空行。
示例:
如下例子不符合规范。
if(VK_ESCAPE==nChar)
{
...//programcode
}
pLeft.x=m_ptCenter.x-m_nRadius;
pLeft.y=m_ptCenter.y-m_nRadius;
应如下书写:
if(VK_ESCAPE==nChar)
{
...//programcode
}
pLeft.x=m_ptCenter.x-m_nRadius;
pLeft.y=m_ptCenter.y-m_nRadius;
1.3较长的语句(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
m_nRadius=(int)sqrt(sqr(m_ptBegin.x-m_ptPrev.x)
+sqr(m_ptBegin.y-m_ptPrev.y));
1.4循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低优先级操作符处划分新行,操作符放在新行之首。
if((ptInter.y>=min(ptStart.y,ptEnd.y))
&&(ptInter.y<=max(ptStart.y,ptEnd.y)))
{
...//programcode
}
1.5若函数或过程中的参数较长,则要进行适当的划分。
1.6不允许把多个短语句写在一行中,即一行只写一条语句。
示例:
如下例子不符合规范。
rect.length=0;rect.width=0;
应如下书写:
rect.length=0;
rect.width=0;
1.7if、for、do、while、case、switch、default等语句自占一行,且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。
示例:
如下例子不符合规范。
if(NULL==pUserCR)return;
应如下书写:
if(NULL==pUserCR)
{
return;
}
1.8程序块的分界符(如C/C++语言的大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:
如下例子不符合规范。
for(...){
...//programcode
}
if(...)
{
...//programcode
}
应如下书写:
for(...)
{
...//programcode
}
1.9在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如->),后不应加空格。
说明:
采用这种松散方式编写代码的目的是使代码更加清晰。
示例如下:
1.9.1逗号、分号只在后面加空格。
inta,b,c;
1.9.2比较操作符,赋值操作符"="、"+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。
if(current_time>=MAX_TIME_VALUE)
{
a=b+c;
}
a*=2;
a=b^2;
1.9.3"!
"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。
*p='a';//内容操作"*"与内容之间
flag=!
isEmpty;//非操作"!
"与内容之间
p=&mem;//地址操作"&"与内容之间
i++;//"++","--"与内容之间
1.9.4"->"、"."前后不加空格。
p->id=pid;//"->"指针前后不加空格
1.9.5if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。
if((a>=b)&&(c>d))
2注释格式约定
2.1一般情况下,源程序有效注释量必须在20%以上。
说明:
注释的原则是有助于对程序的阅读理解,注释不宜太多也不能太少,注释语言必须准确、易懂、简洁。
2.2建议单行注释使用“//……”,多行注释使用“/*……*/”。
说明:
为了注释格式的统一,一般情况下均采用“//……”的注释格式。
2.3说明性文件(如头文件.h文件、.inc文件、.def文件、编译说明文件.cfg等)头部应进行注释,注释必须列出:
版权说明、文件名、作者、版本号、创建日期、功能描述、与其它文件的关系、修改日志等,头文件的注释中还应有函数功能简要说明。
示例:
下面这段头文件的头注释比较标准。
////////////////////////////////////////////////////////////////
//版权所有(C),1999-2002,武汉华工赛百数据系统有限公司
//文件名:
Global.h
//作者:
Tomas
//版本号:
1.00
//创建日期:
2002-2-4
//功能描述:
用于详细说明此程序文件完成的主要功能,与其它类之间的依赖关//系等
//备注:
其它内容的说明
//修改日志:
//1.修改日期:
//修改者:
//修改原因:
//修改内容:
//2....
///////////////////////////////////////////////////////////////
2.4源文件头部应进行注释,列出:
版权说明、文件名、作者、版本号、创建日期、模块描述、修改日志等。
示例:
下面这段源文件的头注释比较标准。
///////////////////////////////////////////////////////////////
//版权所有(C),1999-2002,武汉华工赛百数据系统有限公司
//文件名:
Global.cpp
//作者:
Tomas
//版本号:
1.00
//创建日期:
2002-2-4
//模块描述:
描述本文件内部各模块之间的关系以及与其它文件之间的接口等
//备注:
其它内容的说明
//修改日志:
//1.修改日期:
//修改者:
//修改原因:
//修改内容:
//2....
///////////////////////////////////////////////////////////////
2.5函数头部应进行注释,列出:
函数名称、作者、创建日期、功能描述、输入参数、输出参数、返回值、调用关系(函数、表)、修改日志等。
示例:
下面这段函数的注释比较标准。
////////////////////////////////////////////////////////////////
//函数名称:
//作者:
(此项仅用于全局函数或非文件的创建者编写的函数)
//创建日期:
(此项仅用于全局函数或非文件的创建者编写的函数)
//功能描述:
//输入参数:
//输出参数:
//返回值:
//被本函数调用的函数清单:
//调用本函数的函数清单:
//被访问的表:
(此项仅用于牵扯到数据库操作的函数)
//被修改的表:
(此项仅用于牵扯到数据库操作的函数)
//备注:
//修改日志:
//1.修改日期:
//修改者:
//修改原因:
//修改内容:
//2....
////////////////////////////////////////////////////////////////
2.6边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。
不再有用的注释要删除。
注释的内容要清楚、明了,含义准确,防止注释二义性。
避免在注释中使用缩写,特别是非常用缩写。
2.7注释应与其描述的代码相近,对代码的注释应放在其上方或右方(对单条语句的注释)相邻位置,不可放在下面,如放于上方则需与其上面的代码用空行隔开。
//初始化保存累加和的临时变量为0
intsum=0;
//累加求和
for(count=0;count { sum+=data[count]; } 2.8对于所有有物理含义的变量、常量,如果其命名不是充分自注释的,在声明时都必须加以注释,说明其物理含义。 变量、常量、宏的注释应放在其上方相邻位置或右方。 //圆弧的起点坐标 CPointm_ptBegin; //圆弧的终点坐标 CPointm_ptEnd; 2.9数据结构声明(包括数组、结构、类、枚举等),如果其命名不是充分自注释的,必须加以注释。 对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释放在此域的右方。 //选择工具中出现的几种状态 typedefenumtagSTATUS { ISMOVE,//图形处于移动状态 ISROTATE,//图形处于旋转状态 ISRESIZE,//图形处于放大状态 NOSELECT//图形处于没有选择状态 }STATUS; 2.10全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明。 2.11注释与所描述内容进行同样的缩排。 将注释与其上面的代码用空行隔开。 //圆弧的起点坐标 CPointm_ptBegin; //圆弧的终点坐标 CPointm_ptEnd; 2.12避免在一行代码或表达式的中间插入注释。 在代码的功能、意图层次上进行注释,提供有用、额外的信息。 2.13在程序块的结束行右方加注释标记,以表明某程序块的结束。 if(a>b) {
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- VC 代码 书写 规范